接口描述

請求參數

請求頭參數

請求參數

請求參數示例

{
"model": "1234567890", // 模型ID
"messages": [
{
"role": "user",
"content": "Hello!"
}
]
}

請求返回

非流式返回

非流式正常返回

返回結果示例

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

非流式異常返回

非流式異常返回時：

1. http code 返回非200。

2. http body 中返回 error 結構，error結構中包含code、type、message、param等信息，具體可見【推理服務API—錯誤處理】章節內容。

錯誤結果示例

{
"error" : {
"code" : "500001",
"type" : "INVOKE_MODEL_ERROR",
"message" : "服務接口異常，請聯系管理員"
}
}

流式返回

流式正常返回

返回結果示例

{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"xxx-chat", "choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]}
{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"xxx-chat", "choices":[{"index":0,"delta":{"content":"Hello"},"finish_reason":null}]}
....
{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"xxx-chat", "choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}

stream_options.include_usage 為 True 時多返回一條包含usage流式消息。

{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268199,"model":"xxx-chat", "choices":[], "usage": {"prompt_tokens": 9,"completion_tokens": 120,"total_tokens": 129}}

流式異常返回

流式異常分為兩種：

1. 如果在流式請求接收處理之前發生了異常，如鑒權、參數校驗等問題，與普通的非流式一樣返回http code，并帶有error結構。

2. 如果在流式請求已經接收，會先對外返回流式請求連接建立的信息，此時http code為200，而在后續模型流式返回過程中發生了異常，會在流失返回的chunk返回error結構，并終止當前的流式請求。

流式請求建立后的異常返回示例

{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"xxx-chat", "choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]}
{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"xxx-chat", "choices":[{"index":0,"delta":{"content":"Hello"},"finish_reason":null}]}
....
{"error":{"code":"500001","type":"INVOKE_MODEL_ERROR","message":"服務接口異常，請聯系管理員"}}

請求示例代碼

假設平臺用戶組AppKey=884c8fc4054548a7b1ca1123592f5b7，模型ID=96dcaaaaaaaaaaaa5ff55ea377831a，以此為例進行說明。

curl方式請求

curl --request POST \
--url //wishub-x5.daliqc.cn/api/v1/c760bd1e83/d1a696ae54419d34987d95d52ac337f8/v1/chat/completions \
--header 'Accept: */*' \
--header 'Accept-Encoding: gzip, deflate, br' \
--header 'Authorization: Bearer 884c8fc4054548a7b1ca1123592f5b7' \
--header 'Content-Type: application/json' \
--data '{
"model": "96dcaaaaaaaaaaaa5ff55ea377831a",
"messages": [
{
"role": "user",
"content": "Hello"
}
]
}'

python方式請求

import json
import requests
URL = "//wishub-x5.daliqc.cn/api/v1/c760bd1e83/d1a696ae54419d34987d95d52ac337f8/v1/chat/completions"
headers = {
"Authorization": "Bearer 884c8fc4054548a7b1ca1123592f5b7",
"Content-Type": "application/json"
}
data = {
"model": "96dcaaaaaaaaaaaa5ff55ea377831a",
"messages": [
{"role": "user", "content": "Hello"}
],
"stream": True
}
try:
response = requests.post(URL, headers=headers, json=data, stream=True)
if response.status_code != 200:
print(response.text)
else
for line in response.iter_lines(chunk_size=8192, decode_unicode=True):
## 處理請求
if line :
if "[DONE]" == line:
break
# 去除data前綴:
json_string = line.removeprefix("data:")
# 轉為json: 
jsonData = json.loads(json_string)
# 判斷是否有值
if "choices" in jsonData and len(jsonData["choices"][0]) > 0:
firstChoice = jsonData["choices"][0]
# 取content的邏輯
if "delta" in firstChoice and "content" in firstChoice["delta"] :
# content內容
print(firstChoice["delta"]["content"])
except Exception as e:
print(f"Exception: {e}")

openai 客戶端示例代碼

import openai
from openai import OpenAI
client = OpenAI(base_url="//wishub-x5.daliqc.cn/api/v1/c760bd1e83/d1a696ae54419d34987d95d52ac337f8", api_key="884c8fc4054548a7b1ca1123592f5b7")
messages = [
{"role": "user", "content": "Hello"}
]
try:
stream = client.chat.completions.create(
model="96dcaaaaaaaaaaaa5ff55ea377831a",
messages=messages,
stream=True 
)
# 流式
for chunk in stream:
print(chunk.choices[0].delta.content or "", end="", flush=True)
except openai.APIStatusError as e:
print(f"APIStatusError: {e.status_code}, {e.message}, {e.body}")
except openai.APIError as e:
print(f"APIError: {e.body}")
except Exception as e:
print(f"Exception: {e}")