Chat Tamamlama API
AiHummer bir təkini ifşa edir OpenAI-ə uyğun Mətn dönmələri üçün HTTP son nöqtəsi: POST /v1/chat/completions. Hər hansı bir müştəri və ya SDK artıq OpenAI Chat Tamamlama formatını dəstəkləyirsə, əsas URL-i və API açarını dəyişməklə AiHummer ilə ünsiyyət qura bilər — xüsusi AiHummer kodu tələb olunmur.
Təsdiqləmə
Sorğular ilə təsdiqlənir şəxsi API açarı Bearer tokeni kimi. AiHummer açarları ilə prefix əlavə olunur ah- və veb idarəçi istifadəçi interfeysindən verilirlər.
POST /v1/chat/completions HTTP/1.1
Host: your-aihummer.example
Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
[!TIP] Əsas URL sizin giriş ünvanınızdır. Standart quraşdırmada giriş dinləyir ictimai limanda
:8780, buna görə yerli zəng gedirhttp://localhost:8780/v1/chat/completions. Qapı öz portlarına sahibdir birbaşa — qabağa reverse proxy qoymaq operatorun seçimidir, yoxsa tələblər.
Əsas tələb
JSON məzmunu göndərin messages, elə dəqiq OpenAI-yə edəcəyiniz kimi. model sahə instansiyanızda konfiqurasiya edilmiş modeli (və ya agenti) seçir.
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
}'
Axın olmayan cavab tanış Chat Tamamlama formasını izləyir:
{
"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 }
}
Axın cavabları (SSE)
Dəst "stream": true cavabı tədricən almaq üçün Server Tərəfindən Göndərilən Hadisələr. Hər bir hadisə bir ehtiva edir chat.completion.chunk delta və axın son bir ilə başa çatır data: [DONE] xətt.
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." }
]
}'
Cavab bir 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/completionsdır yalnız OpenAI-ə uyğun son nöqtə səth. AiHummer edir yox aşkar etmək/v1/modelsvə edir yox aşkar etmək/v1/embeddings— yerləşdirmələr daxili bir alt sistemdir və çatılmazdır HTTP üzərindən. Bu marşrutlara güvənməyin; onlar 404 qaytarır.
Kəşf və sxem səthləri
Hələ ki yoxdur /v1/models siyahılama, AiHummer bir neçə kəşf səthi göndərir ki, insanlar və alətlər API-ni araşdıra bilsin:
| Yol | Nəyə xidmət edir |
|---|---|
GET /docs |
İnsan tərəfindən oxuna bilən sənədləşdirmə giriş nöqtəsi |
GET /docs/api |
İnteraktiv API Kəşfiyyatçısı |
GET /docs/openapi.json |
OpenAPI 3.x spesifikasiyası |
GET /openapi.json |
OpenAPI 3.x spesifikasiyası (əsas ləqəb) |
GET /docs/llm.json |
LLM alətləri üçün maşın tərəfindən oxuna bilən API xülasəsi |
GET /llms.txt |
llms.txt LLM agentləri üçün indeks |
# Fetch the OpenAPI spec
curl https://your-aihummer.example/openapi.json
Sistem son nöqtələri
İki yüngül, təsdiqlənməmiş sistem son nöqtəsi canlılıq və saat yoxlamalarına kömək edir:
| Metod və yol | Məqsəd |
|---|---|
GET /v1/ping |
Sadə həyat əlaməti cavabı qaytarır |
GET /v1/time |
Şlüzün cari server vaxtını qaytarır |
curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time
Növbəti haradır
- AiHummer-i öz tətbiqlərinizdən və avtomatlaşdırmalarınızdan idarə edin: Gələn və inteqrasiya tetikleyiciləri.
- Cütləşdirmə, SSO federasiyası və protokol səthləri: Vebhuks, SCIM və cütləşdirmə.
- Agentin nə edə biləcəyini tənzimləyin: Alətlər kataloqu.