Chat Tamamlama API'si
AiHummer tek birini açığa çıkarır OpenAI ile uyumlu Metin dönüşleri için HTTP uç noktası: POST /v1/chat/completions. OpenAI Chat Completions formatını zaten konuşabilen herhangi bir istemci veya SDK, temel URL ve API anahtarını değiştirerek AiHummer ile iletişim kurabilir — AiHummer’a özgü herhangi bir kod gerekli değildir.
Kimlik doğrulama
İstekler bir şekilde kimlik doğrulaması yapılır kişisel API anahtarı Bir Taşıyıcı belirteci olarak. AiHummer anahtarları ile başlar ah- ve web yönetici kullanıcı arayüzünden verilir.
POST /v1/chat/completions HTTP/1.1
Host: your-aihummer.example
Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
[!TIP] Temel URL, ağ geçidi adresinizdir. Varsayılan bir kurulumda ağ geçidi dinler genel bağlantı noktasında
:8780, bu yüzden yerel bir arama şuraya giderhttp://localhost:8780/v1/chat/completions. Ağ geçidi kendi portlarına sahiptir doğrudan — bir ters vekil sunucuyu öne koymak operatörün tercihi, değil gereklilik.
Temel bir istek
Bir JSON gövdesi gönder messages, tıpkı OpenAI’ya yapacağınız gibi. model alan, örneğinizde yapılandırılmış modeli (veya ajanı) seçer.
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
}'
Akışsız bir yanıt, tanıdık Chat Tamamlama biçimini izler:
{
"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 }
}
Akış yanıtları (SSE)
Set "stream": true cevabı kademeli olarak almak için Sunucu Tarafından Gönderilen Olaylar. Her etkinlik bir chat.completion.chunk delta ve akarsu bir son ile sona erer data: [DONE] çizgi.
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." }
]
}'
Cevap 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 sadece OpenAI ile uyumlu uç nokta yüzey. AiHummer yapar değil maruz bırakmak/v1/modelsve yapar değil maruz bırakmak/v1/embeddings— gömme yapılar dahili bir alt sistemdir ve erişilemezler HTTP üzerinden. Bu yollarına güvenmeyin; 404 dönerler.
Keşif ve şema yüzeyleri
Olmadığı sürece /v1/models listeleme, AiHummer, insanların ve araçların API’yi keşfetmesi için birkaç keşif yüzeyi gönderir:
| Yol | Ne işe yarar |
|---|---|
GET /docs |
İnsan tarafından okunabilir dokümantasyon giriş noktası |
GET /docs/api |
Etkileşimli API Gezgini |
GET /docs/openapi.json |
OpenAPI 3.x spesifikasyonu |
GET /openapi.json |
OpenAPI 3.x spesifikasyonu (kök takma ad) |
GET /docs/llm.json |
LLM araçları için makine tarafından okunabilir API özeti |
GET /llms.txt |
llms.txt LLM ajanları için dizin |
# Fetch the OpenAPI spec
curl https://your-aihummer.example/openapi.json
Sistem uç noktaları
İki hafif, kimlik doğrulaması yapılmamış sistem uç noktası canlılık ve saat kontrollerine yardımcı olur:
| Yöntem ve yol | Amaç |
|---|---|
GET /v1/ping |
Basit bir canlılık yanıtı döndürür |
GET /v1/time |
Ağ geçidinin mevcut sunucu zamanını döndürür |
curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time
Sonra nereye?
- Kendi uygulamalarınız ve otomasyonlarınızdan AiHummer’ı sürün: Gelen ve entegrasyon tetikleyicileri.
- Eşleştirme, SSO federasyonu ve protokol yüzeyleri: Webhooks, SCIM ve eşleştirme.
- Ajanın neler yapabileceğini ayarlayın: Araçlar kataloğu.