Chat Completions API — AiHummer Sənədlər

AiHummer mətn növbələri üçün tək bir OpenAI-uyğun HTTP endpoint təqdim edir: POST /v1/chat/completions. Artıq OpenAI Chat Completions formatında danışan istənilən müştəri və ya SDK base URL-i və API açarını dəyişməklə AiHummer ilə danışa bilər — heç bir AiHummer-spesifik kod tələb olunmur.

Autentifikasiya

Sorğular şəxsi API açarı ilə Bearer token kimi autentifikasiya olunur. AiHummer açarları ah- ilə prefiksləşir və veb admin UI-dən verilir.

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

[!TIP] Base URL sizin gateway ünvanınızdır. Defolt quraşdırmada gateway :8780 üzərində dinləyir, beləliklə lokal çağırış http://localhost:8780/v1/chat/completions ünvanına gedir. Produksiyada TLS-i gateway-in qarşısındakı reverse proxy-də dayandırırsınız.

Əsas sorğu

OpenAI-ə göndərdiyiniz kimi, messages ilə JSON gövdə göndərin. model sahəsi 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 Completions 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)

Cavabı Server-Sent Events kimi tədricən almaq üçün "stream": true təyin edin. Hər hadisə bir chat.completion.chunk delta daşıyır, və axın son data: [DONE] sətri ilə bitir.

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-dir:

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-uyğun səthdəki yeganə endpoint-dir. AiHummer /v1/models-i təqdim etmir və /v1/embeddings-i təqdim etmir — embedding-lər daxili alt-sistemdir və HTTP üzərindən əlçatan deyil. Həmin route-lara güvənməyin; onlar 404 qaytarır.

Kəşf və sxem səthləri

/v1/models siyahısı olmasa da, AiHummer insanların və alətlərin API-ni kəşf edə bilməsi üçün bir neçə kəşf səthi göndərir:

Yol	Nə təqdim edir
`GET /docs`	İnsan-oxunaqlı sənədləşmə giriş nöqtəsi
`GET /docs/api`	İnteraktiv API Explorer
`GET /docs/openapi.json`	OpenAPI 3.x spesifikasiyası
`GET /openapi.json`	OpenAPI 3.x spesifikasiyası (kök alias)
`GET /docs/llm.json`	LLM alətləri üçün maşın-oxunaqlı API xülasəsi
`GET /llms.txt`	LLM agentləri üçün `llms.txt` indeksi

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

Sistem endpoint-ləri

İki yüngül, autentifikasiyasız sistem endpoint-i canlılıq və saat yoxlamalarına kömək edir:

Metod və yol	Məqsəd
`GET /v1/ping`	Sadə canlılıq cavabı qaytarır
`GET /v1/time`	Gateway-in cari server vaxtını qaytarır

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

Sonra haraya

AiHummer-i öz tətbiqlərinizdən və avtomatlaşdırmalarınızdan idarə edin: Daxil olan və inteqrasiya tetikləyiciləri.
Cütləşmə, SSO federasiyası və protokol səthləri: Webhook-lar, SCIM və cütləşmə.
Agentin nə edə biləcəyini tənzimləyin: Alətlər kataloqu.