OpenAI API輸入關鍵參數詳解

石映飛云

發布于 2024-12-9 10:53

瀏覽

0收藏

OpenAI API輸入關鍵參數詳解-AI.x社區

主要是發現網上沒有比較新的OpenAI API參數詳情參考，自己到官網上看了最新內容，機翻后簡單修正了下，作為備忘搜索用。

主要參數

messages（object）：包含到目前為止的對話的消息列表。根據您使用的模型，支持不同的消息類型（模態），如文本、圖像和音頻。

model（string）：要使用的模型的ID。

store（bool）：是否存儲此聊天完成請求的輸出。

frequency_penalty（float）：介于-2.0和2.0之間。正值會根據在文本中的現有頻率對新token進行懲罰，從而降低模型逐字重復內容的可能性。

logit_bias（map）：接受一個JSON對象，該對象將標記（由標記器中的標記ID指定）映射到從-100到100的關聯偏置值。從數學上講，在采樣前將偏置添加到模型生成的logit中。確切的效果會因模型而異，但-1和1之間的值應該會減少或增加選擇的可能性，而像-100或100這樣的值應該會導致相關token的禁止或排他性選擇。

logprobs（bool）：是否返回輸出token的概率。如果為true，則返回消息內容中返回的每個輸出標記的對數概率。

max_tokens（integer）：可以生成的token的最大數量。此值可用于控制通過API生成的文本的成本。

n（integer）：最終生成多少個內容結果。

modalities（array）：希望模型為此請求生成的輸出類型，例如["text", "audio"]。

audio（object）：音頻需輸入的參數。當用這個參數時需對應modalities是否輸入audio。

presence_penalty（float）：介于-2.0和2.0之間。正值會根據新token是否出現在文本中來懲罰它們，從而增加模型討論新主題的可能性。

response_format（object）：響應格式。指定模型必須輸出的格式的對象。兼容GPT-4 o、GPT-4 o mini、GPT-4 Turbo和所有比gpt-3.5-turbo-1106更新的GPT-3.5Turbo型號。設置為{ "type": "json_schema", "json_schema": {...} } 將啟用結構化輸出，以確保模型與您提供的JSON模式匹配。如果設置為{“type”：“json_object”}將啟用JSON模式，這將確保模型生成的消息是有效的JSON。

seed（integer）：如果指定，系統將盡最大努力確定性地采樣，這樣具有相同種子和參數的重復請求應該返回相同的結果。但目前此功能為beta狀態，不保證確定性。

temperature（float）：溫度參數，使用什么樣的采樣溫度，在0和2之間。較高的值（如0.8）將使輸出更隨機，而較低的值（如0.2）將使其更集中和確定性。

top_p（float）：溫度采樣的替代方案，稱為nucleus采樣，其中模型考慮具有top_p概率質量的token結果。因此，0.1意味著只考慮包含前10%概率質量的token。

tools（array）：模型可能調用的工具列表。目前，僅支持函數作為工具。使用它來提供模型可能為其生成JSON輸入的函數列表。最多支持128個函數。

tool_choice（string or object）：控制模型調用哪個（如果有）工具。none意味著模型將不調用任何工具，而是生成一條消息。auto意味著模型可以在生成消息或調用一個或多個工具之間進行選擇。required意味著模型必須調用一個或多個工具。通過{"type": "function", "function": {"name": "my_function"}} 指定一個特定的工具會強制模型調用該工具。

請求示例

默認請求：

curl https://api.openai.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": "What'\''s in this image?"
          },
          {
            "type": "image_url",
            "image_url": {
              "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg"
            }
          }
        ]
      }
    ],
    "max_tokens": 300
  }'

結果響應：

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "gpt-4o-mini",
  "system_fingerprint": "fp_44709d6fcb",
  "choices": [{
    "index": 0,
    "message": {
      "role": "assistant",
      "content": "\n\nHello there, how may I assist you today?",
    },
    "logprobs": null,
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21,
    "completion_tokens_details": {
      "reasoning_tokens": 0
    }
  }
}

??https://platform.openai.com/docs/api-reference/chat/create??

本文轉載自??沐白AI筆記??，作者：楊沐白 ?

標簽

OpenAI

API

參數

贊

回復