AI小火箭 - REST API

API地址

环境	URL
生产环境	https://openai.api.ai-whistle.com

认证

所有 API 请求都应在 Authorization HTTP 标头中包含您的 API 密钥，如下所示：

Authorization: Bearer AIR_KEY

AIR_KEY从控制台获取。

第一个请求

您可以将下面的命令粘贴到您的终端中以运行您的第一个 API 请求。确保将 $AIR_KEY 替换为您的 API 密钥。

curl https://openai.api.ai-whistle.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $AIR_KEY" \
  -d '{
     "model": "gpt-3.5-turbo",
     "messages": [{"role": "user", "content": "Say this is a test!"}],
     "temperature": 0.7
   }'

此请求查询 gpt-3.5-turbo 模型以完成以提示“Say this is a test”开头的文本。您应该会收到类似于以下内容的响应：

{
  "id": "chatcmpl-796sNf3vN4DWAXyKpyn9diumOAljv",
  "object": "chat.completion",
  "created": 1682405739,
  "model": "gpt-3.5-turbo-0301",
  "usage": {
    "prompt_tokens": 14,
    "completion_tokens": 5,
    "total_tokens": 19
  },
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "This is a test!"
      },
      "finish_reason": "stop",
      "index": 0
    }
  ]
}

现在你已经生成了你的第一个聊天完成。我们可以看到 finish_reason 是 stop ，这意味着 API 返回了模型生成的完整完成。在此示例中， gpt-3.5-turbo 用于更多的传统文本完成任务。该模型还针对聊天应用程序进行了优化。

支持的API和模型

稳定版本

URL	支持的模型	备注
/v1/chat/completions	gpt-3.5-turbo	ChatGPT
	gpt-3.5-turbo-0301
	gpt-4	暂不支持，即将支持
	gpt-4-0314	暂不支持，即将支持
/v1/completions	text-ada-001	内容补全
	text-babbage-001
	text-curie-001
	text-davinci-002
	text-davinci-003
/v1/embeddings	text-embedding-ada-002	向量生成
	text-similarity-ada-001
	text-similarity-curie-001
/v1/edits/v1/edits	code-davinci-edit-001	文本编辑
	text-davinci-edit-001

Beta版本

以下的接口和模型：访问可能不稳定。

URL	支持的模型	备注
/v1/embeddings	text-search-ada-doc-001 text-search-ada-query-001 text-search-babbage-doc-001 text-search-babbage-query-001 text-search-curie-doc-001 text-search-curie-query-001 text-search-davinci-doc-001 text-search-davinci-query-001	向量生成
	text-similarity-ada-001	向量生成
	text-similarity-curie-001	向量生成
/v1/edits/v1/edits	code-davinci-edit-001	文本编辑
	text-davinci-edit-001	文本编辑

接口详情

Completions

HTTP方法

POST

Header参数

Reduce-Stream

如果请求体中的stream为true，并且头部中的Reduce-Stream为true，返回结果将精简。

URL

{{BASE_URL}}/v1/completions

请求体-参数

参数名	类型	参数说明
model	String	模型名称；必选填写
prompt	string or array
suffix	String	插入文本完成后出现的后缀。 The suffix that comes after a completion of inserted text.
max_tokens	integer	完成时生成的最大tokens数量您的提示加上 max_tokens 的标记计数不能超过模型的上下文长度。大多数模型的上下文长度为 2048 个标记（最新模型除外，它支持 4096）。
temperature	number
top_p	number
n	integer	为每个提示生成多少批结果。本系统会限制数量不超过1。
stream	boolean	是否启用Event Stream
logprobs	integer
echo	boolean	是否返回prompt
stop	string or array
presence_penalty	number
frequency_penalty	number
best_of	integer
logit_bias	map
user	string	代表您的最终用户的唯一标识符

请求体-范例

{
  "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-78sY9YEf4NoN8J16dsZPfJibghPJt",
    "object": "text_completion",
    "created": 1682350669,
    "model": "text-curie-001",
    "choices": [
        {
            "text": "\n\nA rose by any other name would smell just as sweet\n\nBut",
            "index": 0,
            "logprobs": null,
            "finish_reason": "length"
        }
    ],
    "usage": {
        "prompt_tokens": 8,
        "completion_tokens": 16,
        "total_tokens": 24
    }
}

如果请求体中的stream为true，并且头部中的Reduce-Stream为true，返回结果将精简，例如：

data: ["\n"]

data: ["\n"]

data: ["清"]

data: [DONE]

Chat