AiHummer
Eesti▾
SisselogimineKonto
v1.1.x▾
v1.2.xstablev1.1.xstablev1.0.xstable
{ }Swagger
API/Vestluse täiendamise API

Vestluse täiendamise API

v1.1.x · uuendatud 2026-06-26

AiHummer paljastab üksiku OpenAI-ga ühilduv HTTP lõpp-punkt tekstipööramiste jaoks: POST /v1/chat/completions. Iga klient või SDK, mis juba kasutab OpenAI Chat Completions formaati, saab AiHummeriga suhelda, muutes põhi-URL-i ja API võtme — AiHummerile spetsiifiline kood ei ole vajalik.

Autentimine

Päringud autentitakse koos isiklik API-võti kandjatokenina. AiHummeri võtmetel on eesliide ah- ja väljastatakse veebihalduse kasutajaliidesest.

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

[!TIP] Põhi-URL on teie värava aadress. Vaikepaigalduse korral kuulab värav avalikul pordil :8780, seega suunatakse kohalik kõne aadressile http://localhost:8780/v1/chat/completions. Lüüsi omab oma porte otse — pöördproksü paigutamine ette on operaatori valik, mitte nõue.

Põhiline taotlus

Saada JSON-keha koos messages, täpselt nii nagu teeksite OpenAI-le. model väli valib teie eksemplarile seadistatud mudeli (või agendi).

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

Mittevoolav vastus järgib tuttavat vestluse lõpetamise kuju:

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

Voo vastused (SSE)

Seadistama "stream": true vastuse saamiseks järkjärgult nagu Serveri saadetud sündmused. Iga sündmus kannab chat.completion.chunk delta, ja jõgi lõpeb lõppemisega data: [DONE] joon.

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

Vastus on 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 on ainult lõpp-punkt on OpenAI-ga ühilduv pind. AiHummer teeb ei avama /v1/models ja teeb ei avama /v1/embeddings — manused on sisemine alamsüsteem ja neile ei pääse ligi HTTP kaudu. Ära looda nendele marsruutidele; need tagastavad 404.

Avastus ja skeemi pinnad

Kuigi puudub /v1/models loetlemine, AiHummer saadab mitmeid avastuspindu, et inimesed ja tööriistad saaksid API-d uurida:

Tee Millele see teenib
GET /docs Inimese loetav dokumentatsiooni sisenemispunkt
GET /docs/api Interaktiivne API uurija
GET /docs/openapi.json OpenAPI 3.x spetsifikatsioon
GET /openapi.json OpenAPI 3.x spetsifikatsioon (algne alias)
GET /docs/llm.json Masinloetav API kokkuvõte LLM tööriistade jaoks
GET /llms.txt llms.txt LLM-agentide indeks 
# Fetch the OpenAPI spec
curl https://your-aihummer.example/openapi.json

Süsteemi lõpp-punktid

Kaks kerget, autentimata süsteemi lõpp-punkti aitavad elujõulisuse ja kella kontrollidega:

Meetod ja tee Eesmärk
GET /v1/ping Tagastab lihtsa elujõulisuse vastuse
GET /v1/time Tagastab värava praeguse serveri kellaaja 
curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time

Kuhu järgmine