Чат толықтырулары API
AiHummer бір нәрсені көрсетеді OpenAI-пен үйлесімді Мәтіндік ауысуларға арналған HTTP ұш нүктесі: POST /v1/chat/completions. OpenAI Chat Completions форматын білетін кез келген клиент немесе SDK базалық URL мен API кілтін өзгертіп, AiHummer-пен байланыса алады — 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 сіздің шлюз мекенжайыңыз болып табылады. Әдеттегі орнатуда шлюз тыңдайды қоғамдық портта
: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)
Кез келген "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— 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 |
LLM құралдарына арналған машина оқитын API қысқаша мазмұны |
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 және жұптау.
- Агент не істей алатынын баптау: Құралдар каталогы.