Ссылка на API OpenAI
Испытания
curl https://api.openai.com/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
"model": "gpt-3.5-turbo",
"messages": [
{
"role": "system",
"content": "You are a helpful assistant."
},
{
"role": "user",
"content": "Hello!"
}
]
}'
Прокси-интерфейс
Использование CloudFlare
Базовый URL
https://api.openai.com/v1
Заменить в
https://gateway.ai.cloudflare.com/v1/[xxx]/[yyy]/openai
например,
curl https://gateway.ai.cloudflare.com/v1/45a93dd9034ce3d27b263a074d05f09a/ververv/openai/chat/completions \
Определение интерфейса чат
Форматирование ответов
response_format
Должен быть один из text
или json_object
.
Настройка { "type": "json_object"}
включает режим JSON, который гарантирует, что сообщение, генерируемое моделью, является действительным JSON.
-
- Важно: * * при использовании режима JSON вы * * должны * * также указать модель генерировать JSON самостоятельно через систему или пользовательское сообщение.Без этого модель может генерировать бесконечный поток белого пространства до тех пор, пока генерация не достигнет лимита токенов, что приведет к длительному и, казалось бы, «застрявшему» запросу.Также обратите внимание, что содержимое сообщения может быть частично отрезано, если
finish_reason = «length»
, что указывает на то, что генерация превысилаmax_tokens
или разговор превысил максимальную длину контекста.
- Важно: * * при использовании режима JSON вы * * должны * * также указать модель генерировать JSON самостоятельно через систему или пользовательское сообщение.Без этого модель может генерировать бесконечный поток белого пространства до тех пор, пока генерация не достигнет лимита токенов, что приведет к длительному и, казалось бы, «застрявшему» запросу.Также обратите внимание, что содержимое сообщения может быть частично отрезано, если
Функциональные вызовы / Инструменты
Tools: Список инструментов
Каждый инструмент - это объект, и каждый объект имеет
type: В настоящее время поддерживается только функция
.
function: name, description, parameters
Определение каждой параметры:
Имя, тип параметра, описание, факультативное значение, какие параметры требуются
Примеры
-
- Запрос * *
curl https://api.openai.com/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
"model": "gpt-3.5-turbo",
"messages": [
{
"role": "user",
"content": "What is the weather like in Boston?"
}
],
"tools": [
{
"type": "function",
"function": {
"name": "get_current_weather",
"description": "Get the current weather in a given location",
"parameters": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The city and state, e.g. San Francisco, CA"
},
"unit": {
"type": "string",
"enum": ["celsius", "fahrenheit"]
}
},
"required": ["location"]
}
}
}
],
"tool_choice": "auto"
}'
-
- Ответы * *
{
"id": "chatcmpl-abc123",
"object": "chat.completion",
"created": 1699896916,
"model": "gpt-3.5-turbo-0125",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": null,
"tool_calls": [
{
"id": "call_abc123",
"type": "function",
"function": {
"name": "get_current_weather",
"arguments": "{\n\"location\": \"Boston, MA\"\n}"
}
}
]
},
"logprobs": null,
"finish_reason": "tool_calls"
}
],
"usage": {
"prompt_tokens": 82,
"completion_tokens": 17,
"total_tokens": 99
}
}
Большие рамки
{
"model": "gpt-3.5-turbo",
"messages": [
{
"role": "user",
"content": "What is the weather like in Boston?"
}
],
"tools": [ // tool列表,与model同级
{ // 具体某个tool
"type": "function", // 类型:暂时只支持function
"function": {
"name": "get_current_weather",
"description": "Get the current weather in a given location",
"parameters": {
// 更具体定义
}
}
}
],
"tool_choice": "auto" // 选择哪个tool,与model同级
}
параметры
{
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The city and state, e.g. San Francisco, CA"
},
"unit": {
"type": "string",
"enum": [
"celsius",
"fahrenheit"
]
}
},
"required": ["location"],
}