ჩეთის დასრულების API
AiHummer ხსნის ერთს გუნდი OpenAI-სთან თავსებადი HTTP-სამედიცინო წერტილი ტექსტური დიალოგებისთვის: POST /v1/chat/completions. ნებისმიერი კლიენტი ან SDK, რომელიც უკვე მხარს უჭერს OpenAI Chat Completions ფორმატს, შეიძლება იმუშაოს AiHummer-თან, შეიცვალოს ძირითადი URL და API გასაღები — AiHummer-ისთვის სპეციფიკური კოდი საჭირო არ არის.
ავტენტიფიკაცია
მონაცემთა მოთხოვნები ავთენტიფიცირდება შემდეგის საშუალებით პირადი API-კლინი Bearer-ის ტოკენის სახით. AiHummer-ის საკრედიტო კოდებს აქვს წინსართი ah- და გაიცემა ადმინისტრატორის ვებინტერფეისიდან.
POST /v1/chat/completions HTTP/1.1
Host: your-aihummer.example
Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
[!TIP] ბაზისური URL წარმოადგენს თქვენს პორტალის მისამართს. სტანდარტული ინსტალაციის დროს პორტალი ისმენს საჯარო პორტში
:8780, ამიტომ ადგილობრივი ზარი მიმდინარეობსhttp://localhost:8780/v1/chat/completions. ხიდს აქვს საკუთარი პორტები დე-პირდაპირ — რივერს პროქსის წინდება ოპერატორის არჩევანია, არა მოთხოვნა.
მარტივი მოთხოვნა
გაგზავნეთ 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)
კომplekტი "stream": true ხელოვნება პასუხის ეტაპობრივად მიღება როგორც სერვერის მიერ გაგზავნილი მოვლენები. ყოველი მოვლენა შეიცავს საკუთარ თავში 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არის მხოლოდ საბოლოო წერტილი, თავსებადი OpenAI-თან ქედი. AiHummer აკეთებს არა გაშიშვლება/v1/modelsდა აკეთებს არა გაშიშვლება/v1/embeddings— ემბედინგები არის შიდა სუბსისტემა და მიუწვდომელია HTTP-ის საშუალებით. არ ენდოთ ამ მარშრუტებს; ისინი აბრუნებენ 404.
გეგმის გამოვლენა და ზედაპირები
მაგრამ არა /v1/models სია, AiHummer უზრუნველყოფს რამდენიმე კვლევით ზედაპირს, რათა ადამიანები და ინსტრუმენტები შეძლონ API-ის შესწავლა:
| მგზავრობა | რას ემსახურება ეს |
|---|---|
GET /docs |
კონსპექტის შესწავლისთვის ადამიანისთვის შესასვლელი წერტილი |
GET /docs/api |
ინტერაქტიული API მკვლევარი |
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
სისტემის საბოლოო წერტილები
ორი მსუბუქი, უნებითობის სისტემური ბოლო გვეხმარება აქტივობისა და საათების შემოწმებაში:
| მეთოდი და გზა | მიზანი |
|---|---|
GET /v1/ping |
უბრუნებს მარტივ პასუხს მუშაობადობის შესახებ |
GET /v1/time |
აბრუნებს გატარის სერვერის მიმდინარე დროს |
curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time
სად შემდეგ?
- მართეთ AiHummer თქვენი საკუთარი აპლიკაციებიდან და ავტომატიზაციებიდან: მიმდინარე ტრიგერები და ინტეგრაციის ტრიგერები.
- პარინგი, SSO ფედერაცია და პროტოკოლის ზედაპირები: ვებჰუკები, SCIM და ინტეგრაცია.
- დააწყვეთ, რას შეუძლია აგენტს გააკეთოს: ობიექტების კატალოგი.