ChatGPT API 中文版(google翻譯)

2023-11-09

https://platform.openai.com/docs/api-reference/introduction

介紹

您可以通過任何語言的 HTTP 請求、我們的官方 Python 綁定、我們的官方 Node.js 庫或社區維護的庫與 API 進行交互。

安裝官方 Python 綁定，請運行以下命令：

pip install openai

安裝官方 Node.js 庫，請在Node.js 項目目錄中運行以下命令：

npm install openai

認证

OpenAI API 使用 API 密鑰進行身份驗證。訪問您的 API 密鑰頁面以檢索您將在請求中使用的 API 密鑰。

請記住，您的 API 密鑰是秘密的！不要與他人共享或在任何客戶端代碼（瀏覽器、應用程序）中公開它。生產請求必須通過您自己的後端服務器進行路由，您的 API 密鑰可以從環境變量或密鑰管理服務中安全加載。

所有 API 請求都應在 Authorization HTTP 標頭中包含您的 API 密鑰，如下所示：

Authorization: Bearer YOUR_API_KEY

請求組織

對於屬於多個組織的用戶，您可以傳遞一個標頭來指定哪個組織用於 API 請求。來自這些 API 請求的使用將計入指定組織的訂閱配額。

curl 命令行示例:

curl https://api.openai.com/v1/models \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'OpenAI-Organization: YOUR_ORG_ID'

python引入openai包示例:

import os
import openai
openai.organization = "YOUR_ORG_ID"
openai.api_key = os.getenv("OPENAI_API_KEY")
openai.Model.list()

Node.js引入openai包示例:

import { Configuration, OpenAIApi } from "openai";
const configuration = new Configuration({
    organization: "YOUR_ORG_ID",
    apiKey: process.env.OPENAI_API_KEY,
});
const openai = new OpenAIApi(configuration);
const response = await openai.listEngines();

組織 ID 可以在您的組織設置頁面上找到。

发出请求

您可以將下面的命令粘貼到您的終端中以運行您的第一個API 請求。確保將 YOUR_API_KEY 替換為您的秘密 API 密鑰。

curl https://api.openai.com/v1/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"model": "text-davinci-003", "prompt": "Say this is a test", "temperature": 0, "max_tokens": 7}'

此請求查詢 Davinci 模型以完成以提示“Say this is a test”開頭的文本。 max_tokens 參數設置了 API 將返回的令牌數量的上限。您應該會收到類似於以下內容的響應：

{
    "id": "cmpl-GERzeJQ4lvqPk8SkZu4XMIuR",
    "object": "text_completion",
    "created": 1586839808,
    "model": "text-davinci:003",
    "choices": [
        {
            "text": "\n\nThis is indeed a test",
            "index": 0,
            "logprobs": null,
            "finish_reason": "length"
        }
    ],
    "usage": {
        "prompt_tokens": 5,
        "completion_tokens": 7,
        "total_tokens": 12
    }
}

現在你已經生成了你的第一個完成。如果您連接提示和完成文本（如果您將 echo 參數設置為 true，API將為您執行此操作），則生成的文本為“Say this is a test. This indeed atest.”。您還可以將 stream 參數設置為 true，以便 API 流回文本（作為僅數據服務器發送的事件）。

模型(Models)

列出並描述 API 中可用的各種模型。您可以參考模型文檔以了解可用的模型以及它們之間的區別。

模型列表

get https://api.openai.com/v1/models

列出當前可用的模型，並提供有關每個模型的基本信息，例如所有者和可用性。

Example request curl

curl https://api.openai.com/v1/models \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response

{
  "data": [
    {
      "id": "model-id-0",
      "object": "model",
      "owned_by": "organization-owner",
      "permission": [...]
    },
    {
      "id": "model-id-1",
      "object": "model",
      "owned_by": "organization-owner",
      "permission": [...]
    },
    {
      "id": "model-id-2",
      "object": "model",
      "owned_by": "openai",
      "permission": [...]
    },
  ],
  "object": "list"
}

檢索模型

get https://api.openai.com/v1/models/{model}

檢索模型實例，提供有關模型的基本信息，例如所有者和權限。

路徑參數

model string required

用於此請求的模型的 ID

text-davinci-003

curl https://api.openai.com/v1/models/text-davinci-003 \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response

{
  "id": "text-davinci-003",
  "object": "model",
  "owned_by": "openai",
  "permission": [...]
}

完成

給定一個提示，該模型將返回一個或多個預測的完成，並且還可以返回每個位置的替代標記的概率。

創建完成

post https://api.openai.com/v1/completions

為提供的提示和參數創建完成

請求體

model string Required

要使用的模型的 ID。您可以使用 List models API來查看所有可用模型，或查看我們的模型概述以了解它們的描述。

prompt string or array Optional Defaults to <|endoftext|>

生成完成的提示，編碼為字符串、字符串數組、標記數組或標記數組數組。

請注意，<|endoftext|> 是模型在訓練期間看到的文檔分隔符，因此如果未指定提示，模型將生成新文檔的開頭。

suffix string Optional Defaults to null

插入文本完成後出現的後綴。

max_tokens integer Optional Defaults to 16

完成時生成的最大令牌數。

您的提示的令牌計數加上max_tokens 不能超過模型的上下文長度。大多數模型的上下文長度為 2048 個標記（最新模型除外，它支持 4096）。

temperature number Optional Defaults to 1

使用什麼採樣溫度，介於 0 和 2 之間。較高的值（如 0.8）將使輸出更加隨機，而較低的值（如 0.2）將使輸出更加集中和確定。

我們通常建議改變這個或 top_p 但不是兩者都改變。

top_p number Optional Defaults to 1

一種替代溫度採樣的方法，稱為核採樣，其中模型考慮具有 top_p 概率質量的標記的結果。所以 0.1 意味著只考慮構成前 10% 概率質量的標記。

我們通常建議改變這個或溫度，但不能同時改變兩者

n integer Optional Defaults to 1

為每個提示生成多少完成。

注意：因為這個參數會產生很多完成，它會很快消耗你的令牌配額。請謹慎使用並確保您對 max_tokens 和停止進行了合理的設置。

stream boolean Optional Defaults to false

是否回流部分進度。如果設置，令牌將在可用時作為純數據服務器發送事件發送，流由數據終止：[DONE] 消息

logprobs integer Optional Defaults to null

在 logprobs 上包括對數概率最有可能的標記，以及所選標記。例如，如果 logprobs 為 5，則 API 將返回 5 個最有可能的標記的列表。 API 將始終返回採樣令牌的 logprob，因此響應中最多可能有 logprobs+1 個元素。

logprobs 的最大值為 5。如果您需要更多，請通過我們的幫助中心聯繫我們並描述您的用例

echo boolean Optional Defaults to false

除了完成之外回顯提示

stop stringor array Optional Defaults to null

API 將停止生成更多令牌的最多 4 個序列。返回的文本將不包含停止序列

presence_penalty number Optional Defaults to 0

-2.0和 2.0 之間的數字。正值會根據到目前為止是否出現在文本中來懲罰新標記，從而增加模型談論新主題的可能性。

See more information about frequencyand presence penalties.

frequency_penalty number Optional Defaults to 0

-2.0 和 2.0 之間的數字。正值會根據新標記在文本中的現有頻率對其進行懲罰，從而降低模型逐字重複同一行的可能性。

See more information about frequencyand presence penalties.

best_of integer Optional Defaults to 1

在服務器端生成 best_of 完成並返回“最佳”（每個標記具有最高對數概率的那個）。無法流式傳輸結果。

當與 n 一起使用時，best_of 控制候選完成的數量，n 指定返回多少 - best_of 必須大於 n。

注意：因為這個參數會產生很多完成，它會很快消耗你的令牌配額。請謹慎使用並確保您對 max_tokens 和停止進行了合理的設置。

logit_bias map Optional Defaults to null

修改指定標記出現在完成中的可能性。

接受一個 json 對象，該對象將標記（由 GPT 標記器中的標記 ID 指定）映射到從 -100 到100 的相關偏差值。您可以使用此標記器工具（適用於 GPT-2 和 GPT-3）來轉換文本到令牌 ID。從數學上講，偏差會在採樣之前添加到模型生成的對數中。確切的效果因模型而異，但 -1 和 1 之間的值應該會減少或增加選擇的可能性；像 -100 或 100 這樣的值應該導致相關令牌的禁止或獨占選擇。

例如，您可以傳遞 {"50256": -100} 以防止生成 <|endoftext|> 標記。

user string Optional

代表您的最終用戶的唯一標識符，可以幫助 OpenAI 監控和檢測濫用行為。了解更多。

請求

curl https://api.openai.com/v1/completions \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
  "model": "text-davinci-003",
  "prompt": "Say this is a test",
  "max_tokens": 7,
  "temperature": 0
}'

參數

{
  "model": "text-davinci-003",
  "prompt": "Say this is a test",
  "max_tokens": 7,
  "temperature": 0,
  "top_p": 1,
  "n": 1,
  "stream": false,
  "logprobs": null,
  "stop": "\n"
}

響應

{
  "id": "cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7",
  "object": "text_completion",
  "created": 1589478378,
  "model": "text-davinci-003",
  "choices": [
    {
      "text": "\n\nThis is indeed a test",
      "index": 0,
      "logprobs": null,
      "finish_reason": "length"
    }
  ],
  "usage": {
    "prompt_tokens": 5,
    "completion_tokens": 7,
    "total_tokens": 12
  }
}

編輯(Edits)

給定提示和指令，模型將返回提示的編輯版本。

創建編輯

post https://api.openai.com/v1/edits

為提供的輸入、指令和參數創建新的編輯。

model string Required

要使用的模型的 ID。您可以將text-davinci-edit-001 或 code-davinci-edit-001 模型與此端點一起使用。

input string Optional Defaults to ''

用作編輯起點的輸入文本。

instruction string Required

告訴模型如何編輯提示的指令。

n integer Optional Defaults to 1

為輸入和指令生成多少編輯。

temperature number Optional Defaults to 1

使用什麼採樣溫度，介於 0 和2 之間。較高的值（如 0.8）將使輸出更加隨機，而較低的值（如 0.2）將使輸出更加集中和確定。

我們通常建議改變這個或 top_p 但不是兩者都改變。

top_p number Optional Defaults to 1

一種替代溫度採樣的方法，稱為核採樣，其中模型考慮具有top_p 概率質量的標記的結果。所以 0.1 意味著只考慮構成前 10% 概率質量的標記。

我們通常建議更改此值或溫度，但不要同時更改兩者。

請求

curl https://api.openai.com/v1/edits \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
  "model": "text-davinci-edit-001",
  "input": "What day of the wek is it?",
  "instruction": "Fix the spelling mistakes"
}

參數

{
  "model": "text-davinci-edit-001",
  "input": "What day of the wek is it?",
  "instruction": "Fix the spelling mistakes",
}

響應

{
  "object": "edit",
  "created": 1589478378,
  "choices": [
    {
      "text": "What day of the week is it?",
      "index": 0,
    }
  ],
  "usage": {
    "prompt_tokens": 25,
    "completion_tokens": 32,
    "total_tokens": 57
  }
}

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)