Чат Болжолдор API
AiHummer бирөөнү ачыкка чыгарат OpenAIге дал келет Мэтин айлануулары үчүн HTTP учу POST /v1/chat/completions. OpenAI Chat Completions форматы менен мурунтан сүйлөшө алган каалаган кардар же SDK AiHummer менен негизги URL жана API ачкычын өзгөртүп сүйлөшө алат — AiHummerга тиешелүү код талап кылынбайт.
Аутентификация
Суранычтар аутентификацияланат жеке API ачкычы бөлүштүчү токен катары. 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. Гейтвэй өзүнүн портторунун ээси түздөн-түз — агууланган проксиді алдына коюу оператордун тандоосу, эмес талаб
Негизги суроо
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)
Орнотуу "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 менен шайкеш келген endpoint бет. 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 спецификациясы (негизги аlias) |
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 жана жупташтыруу.
- Агент эмне кыла аларын туурала: Куралдар каталогу.