AiHummer
Тоҷикӣ▾
ВоридшавӣКабинети шахсӣ
v1.0.x▾
v1.2.xstablev1.1.xstablev1.0.xstable
{ }Swagger
API/API-и Пурқимати Сӯҳбат

API-и Пурқимати Сӯҳбат

v1.0.x · навсозӣ шуд 2026-06-26

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

Санҷиши эътимод

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

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

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

Як дархости асосӣ

Як баданро бо формати 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
  }'

Ҷавоби ғайримушовиӣ шакли маъруфи Такмилоти Сӯҳбатро пайравӣ мекунад:

{
  "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 барои гирифтани ҷавоб ба таври тадриҷӣ ҳамчун Ҳодисаҳои фиристодаи серверҲар як рӯйдод дорои 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 интерактивӣ
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

Баъд ба куҷо