AiHummer
Türkmençe
Gir
v1.0.x
{ }Swagger

Chat Completions API

v1.0.x · täzelendi 2026-06-26

AiHummer tekst nobatlary üçin ýeke-täk OpenAI bilen utgaşýan HTTP nokady hödürleýär: POST /v1/chat/completions. OpenAI Chat Completions formatynda eýýäm gürleýän islendik müşderi ýa-da SDK esasy URL-i we API açaryny üýtgedip AiHummer bilen gürleşip bilýär — AiHummer-e mahsus kod gerek däl.

Awtorizasiýa

Talaplar şahsy API açary bilen Bearer belgisi hökmünde awtorizasiýa edilýär. AiHummer açarlary ah- prefiksi bilen başlaýar we web admin UI-den çykarylýar.

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

[!TIP] Esasy URL siziň derweze salgyňyzdyr. Deslapky gurnamada derweze :8780 portunda diňleýär, şonuň üçin ýerli çagyryş http://localhost:8780/v1/chat/completions salgysyna gidýär. Önümçilikde TLS-i derwezeden öňdäki tersleýji proksi-de tamamlaýarsyňyz.

Esasy talap

OpenAI-a iberişiňiz ýaly takyk, messages bilen JSON beden iberiň. model meýdany siziň nusgaňyzda sazlanan modeli (ýa-da agenti) saýlaýar.

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
  }'

Akymsyz jogap tanyş Chat Completions görnüşine eýerýär:

{
  "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 }
}

Akymly jogaplar (SSE)

Jogaby kem-kemden Server-Sent Events hökmünde almak üçin "stream": true belläň. Her waka chat.completion.chunk deltasyny göterýär we akym soňky data: [DONE] setiri bilen tamamlanýar.

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." }
    ]
  }'

Jogap text/event-stream görnüşindedir:

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 — bu OpenAI bilen utgaşýan üstdäki ýeke-täk nokat. AiHummer /v1/models-i hödürlemeýär we /v1/embeddings-i hödürlemeýär — embeddingler içerki kiçi ulgamdyr we HTTP üsti bilen elýeterli däldir. Şol ýollara bil baglamaň; olar 404 gaýtarýar.

Tapyş we shema üstleri

/v1/models sanawy ýok bolsa-da, AiHummer adamlar we gurallar API-ni öwrenip bilmegi üçin birnäçe tapyş üstüni iberýär:

Ýol Näme hyzmat edýär
GET /docs Adam okap bilýän resminama giriş nokady
GET /docs/api Interaktiw API Explorer
GET /docs/openapi.json OpenAPI 3.x spesifikasiýasy
GET /openapi.json OpenAPI 3.x spesifikasiýasy (kök alias)
GET /docs/llm.json LLM gurallary üçin maşyn okap bilýän API jemi
GET /llms.txt LLM agentleri üçin llms.txt indeksi
# Fetch the OpenAPI spec
curl https://your-aihummer.example/openapi.json

Ulgam nokatlary

Iki ýeňil, awtorizasiýasyz ulgam nokady janlylyk we sagat barlaglaryna kömek edýär:

Usul we ýol Maksat
GET /v1/ping Ýönekeý janlylyk jogabyny gaýtarýar
GET /v1/time Derwezäniň häzirki serwer wagtyny gaýtarýar
curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time

Indiki nirä