Söhbet Tamamlama API
AiHummer bir sanyny mälim edýär OpenAI bilen utgaşykly Tekst öwrülişikleri üçin HTTP nokady: POST /v1/chat/completions. OpenAI Chat Completions formatynda eýýäm gepleýän islendik müşderi ýa-da SDK, esas URL-ini we API açaryny üýtgedip, AiHummer bilen gürleşip biler — AiHummer üçin häsiýetli koda zerurlyk ýok.
Tassyklama
Haýyşlar bilen tassyklanylýar şahsy API açary Bearer token hökmünde. AiHummer açarlary öňden goşulýar ah- we internet administrasiýa interfeýsinden berilýär.
POST /v1/chat/completions HTTP/1.1
Host: your-aihummer.example
Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
[!TIP] Esasy URL sizin gapyçanyň salgysy. Başlangyç gurnamada gapyça diňleýär umumy portda
:8780, şonuň üçin ýerli jaň bolýarhttp://localhost:8780/v1/chat/completions. Şlüz öz portlaryna eýe gowyça — ters proksi öňe goýmak operatoryň saýlamasy, däldir talap.
Esasy haýyş
JSON gövdesini iberiň messages, takmynan OpenAI-e edýän ýaly. model bu meýdan siziň nusgada sazlanylýan 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 meşhur Chat Completions görnüşine laýyk gelýä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 }
}
Agyzma jogaplar (SSE)
Toplum "stream": true jogaby ädimme-ädim almak üçin Serwerden iberilýän wakalar. Her wakanyň bir chat.completion.chunk delta, we akym ahyry bilen tamamlanýar data: [DONE] setir.
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 şudur 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-dir diňe OpenAI bilen laýyk nokat ýüzük. AiHummer edýär däk açmak/v1/modelswe edýär däk açmak/v1/embeddings— embeddings içki bir ulgamyň bir bölegi bolup, elýeterli däl HTTP arkaly. Ol ýollara bil baglamaly däl; olar 404 berýär.
Gözleg we shema ýüzleri
Heç bolmasa ýok wagtynda /v1/models sanawlamak, AiHummer birnäçe gözleg ýüzlerini iberýär, şonuň üçin adamlar we gurallar API-i öwrenip biler:
| Ýol | Ol näme hyzmat edýär |
|---|---|
GET /docs |
Adam-okap bolýan dokumentasiýanyň girizme nokady |
GET /docs/api |
Interaktiw API Gözleýji |
GET /docs/openapi.json |
OpenAPI 3.x spesifikasiýasy |
GET /openapi.json |
OpenAPI 3.x aýratynlygy (əsas sylag) |
GET /docs/llm.json |
LLM guraly üçin maşyn okap bilinjek API gysgaça mazmuny |
GET /llms.txt |
llms.txt LLM agentleri üçin indeks |
# Fetch the OpenAPI spec
curl https://your-aihummer.example/openapi.json
Ulgam ugrundaky nokatlar
Iki ýeňil agramly, tassyklanmadyk ulgam uç nokady ýaşaýşy we sagat barlaglaryny ýola goýmaga kömek edýär:
| Usul we ýol | Maksat |
|---|---|
GET /v1/ping |
Ýönekeý janlylyk jogabyny yzyna gaýtarýar |
GET /v1/time |
Gapynyň häzirki serwer wagtyny gaýtarýar |
curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time
Indi nire?
- AiHummer-i öz programmaňyz we awtomatlaşdyryşyňiz arkaly dolandyryň: Içeri giriş we integrasiýa tetikleýjiler.
- Jübütleşdirmek, SSO federasiýasy we protokol ýüzleri: Webhooks, SCIM we jübütleşdirmek.
- Agentin edip bilýän zatlaryny sazlaň: Gurnama katalogy.