AiHummer
Lietuvių
PrisijungtiPaskyra
v1.2.x
{ }Swagger

Pokalbių užbaigimo API

v1.2.x · atnaujinta 2026-06-26

AiHummer atskleidžia vieną Suderinamas su OpenAI HTTP galinis taškas teksto sukimams: POST /v1/chat/completions. Bet koks klientas ar SDK, jau palaikantis OpenAI Chat Completions formatą, gali bendrauti su AiHummer pakeitęs pagrindinį URL ir API raktą — nereikia jokio AiHummer specifinio kodo.

Autentifikavimas

Užklausos yra autentifikuojamos su asmeninis API raktas kaip nešėjo žetoną. AiHummer raktai turi priešdėlį ah- ir yra išduodami iš interneto administratoriaus sąsajos.

POST /v1/chat/completions HTTP/1.1
Host: your-aihummer.example
Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

[!TIP] Pagrindinis URL yra jūsų vartų adresas. Numatytojo diegimo metu vartai klausosi viešajame uoste :8780, tad vietinis skambutis nukreipiamas į http://localhost:8780/v1/chat/completions. Vartai priklauso jo prievadai tiesiogiai — priešais statyti atvirkštinį tarpinį serverį yra operatoriaus pasirinkimas, o ne reikalavimas.

Paprastas prašymas

Siųsti JSON turinį su messages, tiksliai taip, kaip tai darytumėte su OpenAI. model laukas pasirenka jūsų instancijoje sukonfigūruotą modelį (arba agentą).

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
  }'

Nestrīminis atsakymas atitinka įprastą Pokalbių užbaigimo formą:

{
  "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 }
}

Srautinių atsakymų (SSE)

Rinkinys "stream": true gauti atsakymą palaipsniui kaip Serverio siunčiami įvykiai. Kiekvienas įvykis turi chat.completion.chunk delta, ir srautas baigiasi galutiniu data: [DONE] eilutė.

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." }
    ]
  }'

Atsakymas yra 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 yra tik galinis taškas suderinamas su OpenAI paviršius. AiHummer daro ne atskleisti /v1/models ir daro ne atskleisti /v1/embeddings — įterpimai yra vidinė posistemė ir nėra pasiekiami per HTTP. Nesikliaukite tais keliais; jie grąžina 404.

Atranka ir schemos paviršiai

Nors nėra /v1/models listavimas, AiHummer siunčia kelias atradimo sąsajas, kad žmonės ir įrankiai galėtų tyrinėti API:

Takelis Kam tai tarnauja
GET /docs Žmogui suprantamas dokumentacijos įrašo pradžios taškas
GET /docs/api Interaktyvus API naršyklė
GET /docs/openapi.json OpenAPI 3.x specifikacija
GET /openapi.json OpenAPI 3.x specifikacija (šakninis alias)
GET /docs/llm.json Mašiniškai skaitomas API santrauka LLM įrankiams
GET /llms.txt llms.txt LLM agentų indeksas
# Fetch the OpenAPI spec
curl https://your-aihummer.example/openapi.json

Sistemos galiniai taškai

Du lengvi, neautentifikuoti sistemos galiniai taškai padeda tikrinti aktyvumą ir laikrodį:

Metodas ir kelias Tikslas
GET /v1/ping Grąžina paprastą gyvybingumo atsakymą
GET /v1/time Grąžina dabartinį vartų serverio laiką
curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time

Kur toliau