Chat Completions API
AiHummer текст кезектери үчүн жалгыз OpenAI-шайкеш HTTP эндпоинтин чыгарат:
POST /v1/chat/completions. OpenAI Chat Completions форматында мурунтан эле сүйлөгөн каалаган
клиент же SDK базалык URLди жана API ачкычты өзгөртүү менен AiHummer менен сүйлөшө алат —
эч кандай AiHummerге мүнөздүү код талап кылынбайт.
Аутентификация
Суроо-талаптар Bearer токени катары жеке API ачкычы менен аутентификацияланат. 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дарегине барат. Продакшнде сиз TLSти шлюздун алдындагы тескери проксиде токтотосуз.
Негизги суроо-талап
OpenAIге жөнөтөрсүз болгондой эле, messages менен JSON денесин жөнөтүңүз. 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)
Жоопту Server-Sent Events катары акырындап алуу үчүн "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 Explorer |
GET /docs/openapi.json |
OpenAPI 3.x спецификациясы |
GET /openapi.json |
OpenAPI 3.x спецификациясы (тамыр алиасы) |
GET /docs/llm.json |
LLM инструменттери үчүн машина окуй турган API кыскача баяны |
GET /llms.txt |
LLM агенттери үчүн llms.txt индекси |
# 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 жана жупташтыруу.
- Агент эмне жасай аларын ынгайлаштырыңыз: Инструменттер каталогу.