API-и Chat Completions — AiHummer Ҳуҷҷатнигорӣ

AiHummer як нуқтаи ниҳоии HTTP-и ягонаи OpenAI-мутобиқ-ро барои навбатҳои матнӣ ошкор мекунад: POST /v1/chat/completions. Ҳар муштарӣ ё SDK-е, ки аллакай формати OpenAI Chat Completions-ро мефаҳмад, метавонад бо тағйир додани base URL ва калиди API бо AiHummer гап занад — ягон коди мушаххаси AiHummer лозим нест.

Аутентификатсия

Дархостҳо бо як калиди API-и шахсӣ ҳамчун токени Bearer аутентификатсия мешаванд. Калидҳои AiHummer бо ah- пешванд карда мешаванд ва аз UI-и админи веб дода мешаванд.

POST /v1/chat/completions HTTP/1.1
Host: your-aihummer.example
Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

[!TIP] Base URL суроғаи шлюзи шумост. Дар насби пешфарз шлюз дар :8780 гӯш медиҳад, бинобар ин даъвати маҳаллӣ ба http://localhost:8780/v1/chat/completions меравад. Дар истеҳсолот шумо TLS-ро дар як reverse proxy-и пеши шлюз қатъ мекунед.

Дархости асосӣ

Як бадани JSON-ро бо messages ирсол кунед, маҳз тавре ки ба OpenAI мекардед. Майдони model моделро (ё агентро), ки дар нусхаи шумо танзим шудааст, интихоб мекунад.

curl https://your-aihummer.example/v1/chat/completions \
  -H "Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "default",
    "messages": [
      { "role": "system", "content": "You are a helpful assistant." },
      { "role": "user", "content": "Summarise our refund policy in two sentences." }
    ],
    "temperature": 0.3
  }'

Як ҷавоби бе стриминг шакли шиносшудаи Chat Completions-ро пайравӣ мекунад:

{
  "id": "chatcmpl-...",
  "object": "chat.completion",
  "created": 1750000000,
  "model": "default",
  "choices": [
    {
      "index": 0,
      "message": { "role": "assistant", "content": "Refunds are issued within 14 days..." },
      "finish_reason": "stop"
    }
  ],
  "usage": { "prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0 }
}

Ҷавобҳои стриминг (SSE)

"stream": true-ро таъин кунед, то ҷавобро ба таври афзоишёбанда ҳамчун Server-Sent Events қабул кунед. Ҳар як рӯйдод як delta-и chat.completion.chunk-ро дар бар мегирад, ва стрим бо хати ниҳоии data: [DONE] ба охир мерасад.

curl -N https://your-aihummer.example/v1/chat/completions \
  -H "Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "default",
    "stream": true,
    "messages": [
      { "role": "user", "content": "Write a one-line greeting." }
    ]
  }'

Ҷавоб як text/event-stream аст:

data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"role":"assistant"}}]}

data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"Hello"}}]}

data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"!"},"finish_reason":"stop"}]}

data: [DONE]

[!WARNING] /v1/chat/completions ягона нуқтаи ниҳоӣ дар сатҳи OpenAI-мутобиқ аст. AiHummer /v1/models-ро ошкор намекунад ва /v1/embeddings-ро ошкор намекунад — embeddings-ҳо як зернизоми дохилӣ ҳастанд ва тавассути HTTP дастрас нестанд. Ба он масирҳо такя накунед; онҳо 404 бармегардонанд.

Сатҳҳои кашфиёт ва схема

Гарчанде рӯйхати /v1/models вуҷуд надорад, AiHummer якчанд сатҳи кашфиётро интиқол медиҳад, то одамон ва асбобҳо API-ро омӯзанд:

Масир	Чиро интиқол медиҳад
`GET /docs`	Нуқтаи вуруди ҳуҷҷатҳои хонданӣ барои инсон
`GET /docs/api`	API Explorer-и интерактивӣ
`GET /docs/openapi.json`	Мушаххасоти OpenAPI 3.x
`GET /openapi.json`	Мушаххасоти OpenAPI 3.x (тахаллуси реша)
`GET /docs/llm.json`	Хулосаи API-и мошинхонӣ барои асбобҳои LLM
`GET /llms.txt`	Индекси `llms.txt` барои агентҳои LLM

# Fetch the OpenAPI spec
curl https://your-aihummer.example/openapi.json

Нуқтаҳои ниҳоии система

Ду нуқтаи ниҳоии системаи сабук ва бе аутентификатсия ба санҷишҳои зиндагӣ ва соат кӯмак мекунанд:

Усул ва масир	Мақсад
`GET /v1/ping`	Як ҷавоби оддии зиндагиро бармегардонад
`GET /v1/time`	Вақти ҷории сервери шлюзро бармегардонад

curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time

Минбаъд ба куҷо

AiHummer-ро аз барномаҳо ва автоматизатсияҳои худ идора кунед: Триггерҳои воридшаванда ва интеграция.
Ҷуфтсозӣ, федератсияи SSO ва сатҳҳои протокол: Webhook-ҳо, SCIM ва ҷуфтсозӣ.
Танзим кунед, ки агент чӣ карда метавонад: Каталоги асбобҳо.