Հրամանային ինտերֆեյսի (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. Վեհարանն իր նավահանգիստներինը տիրապետում է ուղղակիորեն — հետադարձ պրոքսի տեղադրումը դրա առաջ — դա օպերատորի ընտրությունն է, ոչ թե պահանջ
Պարզ հարցում
Ուղարկեք messages պարունակող JSON մարմինը՝ այնպես, ինչպես 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 spécification (արմատային տերմինալ) |
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 և համակցում.
- Կարգավորեք, թե ինչ կարող է գործը կատարել: Պահարան գործիքների.