Chat Completions API
AiHummer აქვეყნებს ერთ OpenAI-თან თავსებად HTTP endpoint-ს ტექსტური ბრუნვებისთვის:
POST /v1/chat/completions. ნებისმიერ კლიენტს ან SDK-ს, რომელიც უკვე საუბრობს OpenAI
Chat Completions ფორმატზე, შეუძლია AiHummer-თან ურთიერთობა საბაზისო URL-ისა და
API-გასაღების შეცვლით — AiHummer-სპეციფიკური კოდი არ არის საჭირო.
ავთენტიკაცია
მოთხოვნები ავთენტიფიცირდება პერსონალური API-გასაღებით Bearer ტოკენის სახით. AiHummer-ის
გასაღებებს აქვს ah- პრეფიქსი და გაიცემა ვებ ადმინ UI-დან.
POST /v1/chat/completions HTTP/1.1
Host: your-aihummer.example
Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
[!TIP] საბაზისო URL არის თქვენი gateway-ის მისამართი. ნაგულისხმევ ინსტალაციაში gateway უსმენს
:8780-ზე, ამიტომ ლოკალური გამოძახება მიდისhttp://localhost:8780/v1/chat/completions-ზე. პროდაქშენში თქვენ TLS-ს ასრულებთ gateway-ის წინ მდგომ reverse proxy-ზე.
ძირითადი მოთხოვნა
გაგზავნეთ JSON სხეული messages-ით, ზუსტად ისე, როგორც OpenAI-სთვის გააკეთებდით. model
ველი ირჩევს მოდელს (ან აგენტს), რომელიც კონფიგურირებულია თქვენს ინსტანციაში.
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
}'
არასტრიმინგ პასუხი მიჰყვება ნაცნობ Chat Completions ფორმას:
{
"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 }
}
სტრიმინგ პასუხები (SSE)
დააყენეთ "stream": true რათა მიიღოთ პასუხი ეტაპობრივად
Server-Sent Events-ის სახით. თითოეული მოვლენა ატარებს chat.completion.chunk დელტას, და
სტრიმი მთავრდება საბოლოო data: [DONE] ხაზით.
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." }
]
}'
პასუხი არის 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არის ერთადერთი endpoint OpenAI-თან თავსებად ზედაპირზე. AiHummer არ აქვეყნებს/v1/models-ს და არ აქვეყნებს/v1/embeddings-ს — embeddings არის შიდა ქვესისტემა და ხელმისაწვდომი არ არის HTTP-ზე. ნუ დაეყრდნობით ამ მარშრუტებს; ისინი აბრუნებენ 404-ს.
აღმოჩენისა და სქემის ზედაპირები
მიუხედავად იმისა, რომ არ არსებობს /v1/models ჩამონათვალი, AiHummer აწვდის რამდენიმე აღმოჩენის ზედაპირს
რათა ადამიანებმა და ხელსაწყოებმა შეძლონ API-ის შესწავლა:
| Path | რას აწვდის |
|---|---|
GET /docs |
ადამიანისთვის წასაკითხი დოკუმენტაციის შესასვლელი წერტილი |
GET /docs/api |
ინტერაქტიული API Explorer |
GET /docs/openapi.json |
OpenAPI 3.x სპეციფიკაცია |
GET /openapi.json |
OpenAPI 3.x სპეციფიკაცია (ძირეული მეტსახელი) |
GET /docs/llm.json |
მანქანისთვის წასაკითხი API შეჯამება LLM ხელსაწყოებისთვის |
GET /llms.txt |
llms.txt ინდექსი LLM აგენტებისთვის |
# Fetch the OpenAPI spec
curl https://your-aihummer.example/openapi.json
სისტემური endpoint-ები
ორი მსუბუქი, არაავთენტიფიცირებული სისტემური endpoint ეხმარება სიცოცხლისუნარიანობისა და საათის შემოწმებაში:
| მეთოდი და path | დანიშნულება |
|---|---|
GET /v1/ping |
აბრუნებს მარტივ სიცოცხლისუნარიანობის პასუხს |
GET /v1/time |
აბრუნებს gateway-ის მიმდინარე სერვერის დროს |
curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time
სად შემდეგ
- მართეთ AiHummer თქვენი საკუთარი აპებიდან და ავტომატიზაციებიდან: შემომავალი და ინტეგრაციის ტრიგერები.
- დაწყვილება, SSO ფედერაცია და პროტოკოლის ზედაპირები: Webhooks, SCIM და დაწყვილება.
- დააკონფიგურირეთ რა შეუძლია აგენტს: ხელსაწყოების კატალოგი.