Tērzēšanas pabeigšanas API
AiHummer atklāj vienu OpenAI saderīgs HTTP galapunkts teksta pārvēršanai: POST /v1/chat/completions. Jebkurš klients vai SDK, kas jau izmanto OpenAI Chat Completions formātu, var sazināties ar AiHummer, mainot pamat-URL un API atslēgu — nav nepieciešams AiHummer specifisks kods.
Autentifikācija
Pieprasījumi tiek autentificēti ar personīgais API atslēga kā Nesēja marķieris. AiHummer atslēgām ir priekšvārds ah- un tiek izsniegti no tīmekļa administratora lietotāja interfeisa.
POST /v1/chat/completions HTTP/1.1
Host: your-aihummer.example
Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
[!TIP] Bāzes URL ir jūsu vārtejas adrese. Noklusējuma instalācijā vārteja klausās uz publisko ostu
:8780, tāpēc vietējais zvans tiek novirzīts uzhttp://localhost:8780/v1/chat/completions. Vārteja pieder tās ostām tieši — apgriezta starpniekservera ievietošana priekšā ir operatora izvēle, nevis prasība.
Vienkāršs pieprasījums
Nosūtīt JSON ķermeni ar messages, tieši tāpat kā jūs to darītu OpenAI. model lauks izvēlas modeli (vai aģentu), kas konfigurēts jūsu instancē.
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
}'
Nestrīmējoša atbilde seko ierastajam Čata pabeigšanas veidam:
{
"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 }
}
Straumēšanas atbildes (SSE)
Komplekts "stream": true saņemt atbildi pakāpeniski kā Servera sūtīti notikumi. Katrs notikums nes sev līdzi chat.completion.chunk delta, un straume beidzas ar galīgo data: [DONE] līnija.
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." }
]
}'
Atbilde ir 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/completionsir tikai galapunkts, kas ir saderīgs ar OpenAI virsma. AiHummer dara ne atklāt/v1/modelsun dara ne atklāt/v1/embeddings— iegultās sistēmas ir iekšēja apakšsistēma un nav sasniedzamas pār HTTP. Neuzticieties šiem maršrutiem; tie atgriež 404.
Atklājumi un shēmu virsmas
Lai gan nav /v1/models listēšana, AiHummer piegādā vairākas atklāšanas virsmas, lai cilvēki un rīki varētu izpētīt API:
| Ceļš | Kam tas kalpo |
|---|---|
GET /docs |
Cilvēkam saprotama dokumentācijas ievada punkts |
GET /docs/api |
Interaktīvs API pārlūks |
GET /docs/openapi.json |
OpenAPI 3.x specifikācija |
GET /openapi.json |
OpenAPI 3.x specifikācija (saknes aizstājvārds) |
GET /docs/llm.json |
Mašīnlasāms API kopsavilkums LLM rīkiem |
GET /llms.txt |
llms.txt indekss LLM aģentiem |
# Fetch the OpenAPI spec
curl https://your-aihummer.example/openapi.json
Sistēmas galapunkti
Divi viegli, neautentificēti sistēmas galapunkti palīdz dzīvotspējas un pulksteņa pārbaudēs:
| Metode un ceļš | Mērķis |
|---|---|
GET /v1/ping |
Atgriež vienkāršu dzīvotspējas atbildi |
GET /v1/time |
Atgriež vārtejas pašreizējo servera laiku |
curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time
Kur uz nākamo
- Vadiet AiHummer no savām lietotnēm un automatizācijām: Ienākošie un integrācijas aktivatori.
- Savienošana, SSO federācija un protokola virsmas: Tīmekļa āķi, SCIM un savienošana.
- Noregulējiet, ko aģents var darīt: Rīku katalogs.