Мазмұнға өту
DEVELOPERS

7. Alem модулі

Мәтін генерациялау, ағынмен беру, эмбеддингтер, саралау және аудионы мәтінге айналдыру.

ALEM модулі Alem.Cloud платформасының модельдеріне қолжетімділік береді. Модуль OpenAI API және Anthropic Messages API форматтарымен үйлесімді, бұл аталған жеткізушілердің ресми SDK-ларын базалық мекенжай мен кілтті ауыстыру арқылы пайдалануға мүмкіндік береді.

Модуль ALEM модулі көрсетілген API токені және qairu.alem.read қолжетімділік аясы бар студенттің қолжетімділік токені бойынша қолжетімді. Деректер модульдерінен айырмашылығы, ALEM модулі осы бөлімде аталған жолдар бойынша POST әдісімен жіберілген сұрауларды қабылдайды.

7.1. SDK қосу

SDK базалық мекенжайы ретінде модуль мекенжайы, кілт ретінде токен көрсетіледі:

URL
https://api.bbx.kz/os/v1/alem
  • OpenAI SDK — base_url (Python) немесе baseURL (JavaScript) параметрі;
  • Anthropic SDK — сол мекенжай; /v1/messages жолын SDK өзі қосады.

7.2. Мәтін генерациялау

Жауапты генерациялау OpenAI форматындағы POST /os/v1/alem/chat/completions сұрауымен орындалады. Сондай-ақ POST /os/v1/alem/completions және POST /os/v1/alem/responses операцияларына қолдау көрсетіледі.

curl https://api.bbx.kz/os/v1/alem/chat/completions \
  -H "Authorization: Bearer qos_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "deepseek-ai/DeepSeek-V4.1-Flash",
    "messages": [
      {"role": "system", "content": "You are a concise assistant."},
      {"role": "user", "content": "Explain supervised learning in two sentences."}
    ],
    "max_tokens": 512
  }'

Anthropic Messages API форматындағы сұраулар POST /os/v1/alem/v1/messages жолына жіберіледі.

curl https://api.bbx.kz/os/v1/alem/v1/messages \
  -H "x-api-key: qos_YOUR_TOKEN" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "deepseek-ai/DeepSeek-V4.1-Flash",
    "max_tokens": 512,
    "messages": [
      {"role": "user", "content": "Explain supervised learning in two sentences."}
    ]
  }'

7.3. Ағынмен беру

"stream": true параметрі берілгенде жауап қалыптасу барысында text/event-stream оқиғалар ағынымен беріледі. OpenAI форматындағы ағын data: [DONE] жолымен аяқталады. Егер клиент stream_options параметрін бермесе, ағынға токендердің жұмсалуы туралы usage мәліметтері бар қорытынды фрагмент қосылады; бұл фрагменттегі choices массиві бос болады.

curl -N https://api.bbx.kz/os/v1/alem/chat/completions \
  -H "Authorization: Bearer qos_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "deepseek-ai/DeepSeek-V4.1-Flash",
    "stream": true,
    "messages": [
      {"role": "user", "content": "Write a short abstract about computer vision."}
    ]
  }'

7.4. Эмбеддингтер

Мәтіндердің векторлық көріністерін POST /os/v1/alem/embeddings сұрауы қайтарады. input параметрі жолды немесе жолдар массивін қабылдайды.

curl https://api.bbx.kz/os/v1/alem/embeddings \
  -H "Authorization: Bearer qos_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "BAAI/bge-m3",
    "input": ["Neural networks", "Gradient descent"]
  }'

7.5. Саралау

POST /os/v1/alem/rerank сұрауы құжаттарды сұрауға сәйкестігі бойынша реттейді. Сұрау мен жауап форматы Cohere Rerank форматына сәйкес келеді: жауапта құжат нөмірі index және сәйкестік бағасы relevance_score көрсетілген results массиві болады. OpenAI және Anthropic ресми SDK-лары бұл операцияға қолдау көрсетпейді, сондықтан сұрау HTTP-клиент құралдарымен орындалады.

curl https://api.bbx.kz/os/v1/alem/rerank \
  -H "Authorization: Bearer qos_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "BAAI/bge-reranker-v2-m3",
    "query": "How is the final grade calculated?",
    "documents": [
      "The final grade combines coursework and the examination.",
      "The library is open from 9 a.m. to 8 p.m.",
      "Coursework accounts for sixty percent of the final grade."
    ],
    "top_n": 2
  }'

7.6. Аудиожазбаларды мәтінге айналдыру

Аудиожазбаны мәтінге айналдыру multipart/form-data форматындағы POST /os/v1/alem/audio/transcriptions сұрауымен орындалады. file өрісінде аудиожазба, model өрісінде сөйлеуді тану моделінің идентификаторы беріледі. response_format=verbose_json мәні берілгенде жауапта уақыт белгілері бар мәтін фрагменттері қосымша беріледі. Файл көлемі 100 МБ-тан аспауға тиіс.

curl https://api.bbx.kz/os/v1/alem/audio/transcriptions \
  -H "Authorization: Bearer qos_YOUR_TOKEN" \
  -F model=openai/whisper-large-v3 \
  -F response_format=verbose_json \
  -F file=@lecture.mp3

7.7. Пайымдауды ажырату

Кейбір модельдер жауап берер алдында max_tokens лимитін жұмсайтын пайымдау қалыптастырады. max_tokens мәні аз болғанда мұндай модель "finish_reason": "length" белгісімен бос content өрісін қайтаруы мүмкін. Пайымдауды ажырату үшін сұрау денесіне "chat_template_kwargs": {"enable_thinking": false} параметрі қосылады; Python тіліне арналған OpenAI SDK-да ол extra_body арқылы беріледі. Модельдердің бір бөлігі бұл параметрді ескермейді.

curl https://api.bbx.kz/os/v1/alem/chat/completions \
  -H "Authorization: Bearer qos_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "deepseek-ai/DeepSeek-V4.1-Flash",
    "messages": [{"role": "user", "content": "List three sorting algorithms."}],
    "max_tokens": 256,
    "chat_template_kwargs": {"enable_thinking": false}
  }'

7.8. Модельді таңдау және қолдау көрсетілмейтін операциялар

  • model параметрі модульдің барлық операциялары үшін міндетті; модель идентификаторларын GET /os/v1/alem/models жауабынан алу қажет;
  • тізбеде жоқ модельге жіберілген сұрау model_not_found кодымен, токен рұқсат бермеген модельге жіберілген сұрау model_not_allowed кодымен қабылданбайды;
  • кескін генерациялауға, сөйлеу синтезіне, модерацияға, файлдармен, векторлық қоймалармен және пакеттік тапсырмалармен жұмыс істеуге модуль қолдау көрсетпейді; мұндай жолдарға жіберілген сұраулар not_found кодымен қабылданбайды;
  • модель сұрауды өңдеген кезде пайда болған 400, 404, 413, 422 және 429 кодты қателер клиентке өзгеріссіз беріледі; Alem.Cloud платформасының ақауы немесе қолжетімсіздігі upstream_error кодымен 502 жауабы ретінде қайтарылады.

Қолжетімді модельдер «Модельдер тізбесі» бөлімінде келтірілген.