你的位置：首页 > 业界 > OpenAI ChatGPT API详细文档对接

OpenAI ChatGPT API详细文档对接

业界 admin 2024-12-19 42浏览 0评论

接口文档

概述

本接口提供了对接OpenAI ChatGPT的功能，允许开发者通过API与ChatGPT模型进行交互，实现自然语言理解和生成。此接口需要使用POST方法请求，并且需要提供有效的API密钥和输入数据以确保请求的成功。

API基础信息

API Endpoint: https://api.openai/v1/engines/davinci-codex/completions
请求方法: POST
认证方式: Bearer Token

请求头

头字段	值类型	描述
Authorization	string	Bearer后接API密钥
Content-Type	string	应设置为`application/json`

请求参数

请求体需以JSON格式发送，以下参数包含在请求体中：

参数名	必选	类型	说明
prompt	是	string	要发送给模型的提示，即用户的输入
max_tokens	否	int	生成的最大令牌数，默认为256
temperature	否	float	控制输出的确定性，默认为1
top_p	否	float	控制采样的创造性，默认为1
n	否	int	要生成的完成数量，默认为1
stop	否	string/array	生成停止的序列
frequency_penalty	否	float	频率惩罚，控制重复，默认为0
presence_penalty	否	float	存在惩罚，控制新颖性，默认为0

返回值

返回JSON格式的数据。包含模型生成的文本。

示例

请求示例：

json

POST /v1/engines/davinci-codex/completions HTTP/1.1
Host: api.openai
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "prompt": "Translate the following English text to French: 'Hello, how are you?'",
  "max_tokens": 60,
  "temperature": 0.5
}

返回示例：

json

{
  "id": "cmpl-2c3hrnT08cFPRgVJF3a8h2Fb",
  "object": "text_completion",
  "created": 1589478378,
  "model": "davinci-codex",
  "choices": [
    {
      "text": "Bonjour, comment ça va?",
      "index": 0,
      "logprobs": null,
      "finish_reason": "length"
    }
  ]
}

注意事项

需要注册OpenAI账户并获取API密钥才能使用此接口。
请确保API密钥保密，不要在客户端直接暴露密钥。
根据使用的模型和所生成的令牌数量，使用此接口可能会产生费用。请参考OpenAI的定价策略以获取详细信息。
OpenAI提供的API可能会有使用限制，例如请求频率限制，请遵守相关规定。
返回的数据结构可能随OpenAI API的更新而变化，请以实际返回为准。

接口文档

概述

API基础信息

API Endpoint: https://api.openai/v1/engines/davinci-codex/completions
请求方法: POST
认证方式: Bearer Token

请求头

头字段	值类型	描述
Authorization	string	Bearer后接API密钥
Content-Type	string	应设置为`application/json`

请求参数

请求体需以JSON格式发送，以下参数包含在请求体中：

参数名	必选	类型	说明
prompt	是	string	要发送给模型的提示，即用户的输入
max_tokens	否	int	生成的最大令牌数，默认为256
temperature	否	float	控制输出的确定性，默认为1
top_p	否	float	控制采样的创造性，默认为1
n	否	int	要生成的完成数量，默认为1
stop	否	string/array	生成停止的序列
frequency_penalty	否	float	频率惩罚，控制重复，默认为0
presence_penalty	否	float	存在惩罚，控制新颖性，默认为0

返回值

返回JSON格式的数据。包含模型生成的文本。

示例

请求示例：

json

POST /v1/engines/davinci-codex/completions HTTP/1.1
Host: api.openai
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "prompt": "Translate the following English text to French: 'Hello, how are you?'",
  "max_tokens": 60,
  "temperature": 0.5
}

返回示例：

json

{
  "id": "cmpl-2c3hrnT08cFPRgVJF3a8h2Fb",
  "object": "text_completion",
  "created": 1589478378,
  "model": "davinci-codex",
  "choices": [
    {
      "text": "Bonjour, comment ça va?",
      "index": 0,
      "logprobs": null,
      "finish_reason": "length"
    }
  ]
}

注意事项

需要注册OpenAI账户并获取API密钥才能使用此接口。
请确保API密钥保密，不要在客户端直接暴露密钥。
根据使用的模型和所生成的令牌数量，使用此接口可能会产生费用。请参考OpenAI的定价策略以获取详细信息。
OpenAI提供的API可能会有使用限制，例如请求频率限制，请遵守相关规定。
返回的数据结构可能随OpenAI API的更新而变化，请以实际返回为准。