चैट पूर्णताएँ एपीआई

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

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

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

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

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]

# Fetch the OpenAPI spec
curl https://your-aihummer.example/openapi.json

curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time

AiHummer एकल का प्रदर्शन करता है **OpenAI-संगत** पाठ घुमावों के लिए HTTP एंडपॉइंट: `POST /v1/chat/completions`. कोई भी क्लाइंट या SDK जो पहले से OpenAI चैट पूर्णता फॉर्मेट बोलता है, AiHummer से बात कर सकता है केवल बेस URL और API कुंजी बदलकर — कोई विशेष AiHummer कोड की आवश्यकता नहीं है। ## प्रमाणीकरण अनुरोधों को एक के साथ प्रमाणित किया जाता है **व्यक्तिगत एपीआई कुंजी** एक बीयरर टोकन के रूप में। AiHummer कुंजी के आगे जोड़ा जाता है `ah-` और वे वेब व्यवस्थापक UI से जारी किए जाते हैं। ```http 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` फील्ड उस मॉडल (या एजेंट) का चयन करता है जो आपके इंस्टेंस पर कॉन्फ़िगर किया गया है। ```bash 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 }' ``` एक गैर-स्ट्रीमिंग प्रतिक्रिया परिचित चैट पूर्णता संरचना का पालन करती है: ```json { "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]` लाइन। ```bash 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`: ```text 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` | इंटरैक्टिव एपीआई एक्सप्लोरर | | `GET /docs/openapi.json` | OpenAPI 3.x विनिर्देशन | | `GET /openapi.json` | OpenAPI 3.x विनिर्देश (रूट उपनाम) | | `GET /docs/llm.json` | LLM उपकरणों के लिए मशीन-पठनीय API सारांश | | `GET /llms.txt` | `llms.txt` एलएलएम एजेंट्स के लिए सूची | ```bash # Fetch the OpenAPI spec curl https://your-aihummer.example/openapi.json ``` ## सिस्टम एंडपॉइंट्स दो हल्के, अप्रमाणित सिस्टम एंडपॉइंट जीवनता और घड़ी की जाँच में मदद करते हैं: | विधि और पथ | उद्देश्य | |---|---| | `GET /v1/ping` | साधारण जीवंतता प्रतिक्रिया लौटाता है | | `GET /v1/time` | गेटवे का वर्तमान सर्वर समय लौटाता है | ```bash curl https://your-aihummer.example/v1/ping curl https://your-aihummer.example/v1/time ``` ## अगला कहाँ - अपने स्वयं के ऐप्स और ऑटोमेशन से AiHummer चलाएँ: [इनबाउंड और एकीकरण ट्रिगर](/hi/v1.0/api/inbound-triggers). - पेयरिंग, SSO फ़ेडरेशन और प्रोटोकॉल सतहें: [वेबहुक्स, एससीआईएम और पेयरिंग](/hi/v1.0/api/webhooks-scim-pairing). - एजेंट क्या कर सकता है उसे ट्यून करें: [उपकरण सूची](/hi/v1.0/reference/tools-catalog).