Чат дуусгах API
AiHummer нь нэг зүйл илчилдэг OpenAI-тэй нийцдэг Текстийн эргүүлэлтийн HTTP цэг POST /v1/chat/completions. Аль ч клиент эсвэл SDK нь аль хэдийн OpenAI Chat Completions формат дээр ажиллаж байгаа бол суурь 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— эмбеддингс нь дотоод дэд систем бөгөөд хүрч болохгүй 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 ба хослол.
- Төлөөлөгч юу хийж чадахыг тохируулна уу: Багаж хэрэгслийн каталог.