Developer guide
API deitzea
API bateragarrietarako bideak eta streaming-aren eta ahotsaren arauak
Orrialde honek autentifikazioa amaitu ondoren benetan deitzen diren bideak lantzen ditu.
OpenAI-rekin bateragarria den bidearen eta Anthropic-rekin bateragarria den bidearen zerrenda, eskaeraren gorputzean stream gaitzen denean erantzuna jasotzeko modua,
eta ahotsaren eta voice-en bideei soilik aplikatzen zaizkien arauen hurrenkera azaltzen ditu.
Modeloen IDak eta modelo bakoitzerako baimendutako deiak modeloen orrialdean daude; autentifikazio-goiburuak eta base URL-a, berriz, API gakoarekin autentifikatzea orrialdean.
Aukeratu bidea
Bi bateragarritasun-estandarrak API gako bera erabiltzen dute, eta elkarrizketa-eredu inferentzialetara bi estandarretatik dei daiteke. Aukeratu bidea egin nahi duzunaren eta erabiltzen duzun SDK-aren arabera.
| Egin nahi dena | Estandarra | Bidea |
|---|---|---|
| Elkarrizketa-inferentzia, OpenAI SDK erabiltzea | OpenAI-rekin bateragarria | POST /chat/completions edo POST /responses |
| Elkarrizketa-inferentzia, Anthropic SDK erabiltzea | Anthropic-rekin bateragarria | POST /v1/messages |
| Embedding-ak sortzea | OpenAI-rekin bateragarria | POST /embeddings |
| Ahots-sintesia eta transkripzioa, voice-en kudeaketa | OpenAI-rekin bateragarria | /audio eta /voices azpiko bideak |
| Dei daitezkeen modeloak egiaztatzea | Biak | GET /models |
OpenAI-rekin bateragarria den bidea
base URL-a https://platform.clevi.net/api/v2/aiservice/openai/v1 da, eta eskaeren eta erantzunen gorputzek OpenAI-ren estandarra jarraitzen dute. Beheko taulan inferentzia- eta modelo-bideak daude; ahotsaren eta voice-en bideak hurrengo atalean jaso dira bereizita.
| Metodoa | Bidea | Azalpena |
|---|---|---|
| POST | /api/v2/aiservice/openai/v1/chat/completions | Elkarrizketa bidezko arrazoiketa. stream gaituz gero, SSE bidez erantzuten du. |
| POST | /api/v2/aiservice/openai/v1/responses | Responses formatuko deia. stream onartzen du. |
| GET | /api/v2/aiservice/openai/v1/responses/{responseId} | Gordetako erantzun bat kontsultatzen du. |
| GET | /api/v2/aiservice/openai/v1/responses/{responseId}/input_items | Gordetako erantzunaren sarrera-elementuen zerrenda da. |
| POST | /api/v2/aiservice/openai/v1/responses/{responseId}/cancel | Atzeko planoan egiten ari den erantzuna bertan behera uzten du. |
| DELETE | /api/v2/aiservice/openai/v1/responses/{responseId} | Gordetako erantzuna ezabatzen du. |
| POST | /api/v2/aiservice/openai/v1/completions | Testuaren osatze legatua. stream onartzen du. |
| POST | /api/v2/aiservice/openai/v1/embeddings | Embedding-a sortzen du. Ez du streaming-a onartzen. |
| GET | /api/v2/aiservice/openai/v1/models | Gako honekin deitu daitezkeen modeloen zerrenda da. |
| GET | /api/v2/aiservice/openai/v1/models/{modelId} | Modelo bat kontsultatzen du. Sarbiderik ez badago, 404 itzultzen du. |
curl https://platform.clevi.net/api/v2/aiservice/openai/v1/chat/completions \
-H "X-API-Key: sk-..." \
-H "Content-Type: application/json" \
-d '{
"model": "cip-5.5-im",
"messages": [{"role": "user", "content": "안녕하세요"}]
}'API gakoen pantailan emandako gakoa jarri sk-... lekuan, eta modeloaren orriko IDa model-en.
Gainerako bideak
| Bidea | Azalpena |
|---|---|
| GET /api/v2/aiservice/openai/v1/healthz | Ahots-providerraren egoera egiaztatzen du. |
| /api/v2/aiservice/openai/v1/api/status · /api/options · /api/generate · /outputs/{filename} | Cosa zaharraren egoera eta aukerak kontsultatzeko, sortzeko deia egiteko (multipart) eta emaitzak deskargatzeko erabiltzen da. |
| /api/v2/aiservice/openai/v1/{routeKey} (GET · POST · PUT · PATCH · DELETE) | Goian agertzen ez diren provider-en bideak arauak aplikatuz birbideratzen ditu. POST bidezko birbidalketarekin chat/completions, completions, embeddings eta responses deitzen badira, 404 itzultzen da; lau horiek bide dedikatuek kudeatzen dituzte. |
Anthropic-ekin bateragarria den bidea
base URL https://platform.clevi.net/api/v2/aiservice/anthropic da, eta Anthropic SDK-k automatikoki gehitzen dio /v1 bideari. Eskaeren eta erantzunen gorputzek Anthropic Messages zehaztapena jarraitzen dute.
| Metodoa | Bidea | Deskribapena |
|---|---|---|
| POST | /api/v2/aiservice/anthropic/v1/messages | Messages zehaztapenaren araberako deia. model, messages eta max_tokens behar dira, eta stream onartzen du. |
| POST | /api/v2/aiservice/anthropic/v1/messages/count_tokens | Sarrerako token kopurua soilik estimatzen du, kobratu gabe. Ez da max_tokens behar. |
| GET | /api/v2/aiservice/anthropic/v1/models | Ereduen zerrenda kurtsore bidezko orrikatzearekin. limit 1 eta 1000 artekoa da; barrutitik kanpo badago, 400 da. |
| GET | /api/v2/aiservice/anthropic/v1/models/{modelId} | Eredu baten kontsulta. Ezin bada atzitu, 404 da. |
curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/messages \
-H "X-API-Key: sk-..." \
-H "anthropic-version: 2023-06-01" \
-H "Content-Type: application/json" \
-d '{
"model": "cip-5.5-im",
"max_tokens": 1024,
"messages": [{"role": "user", "content": "안녕하세요"}]
}'Streaming-a (SSE)
Eskaeraren gorputzean "stream": true sartzen baduzu, zerbitzariak Server-Sent Events bidez erantzuten du. Bidea eta ereduaren arabera, honela funtzionatzen du.
| Helburua | Funtzionamendua |
|---|---|
| OpenAI-rekin bateragarria den POST /chat/completions · POST /completions · POST /responses | stream onartzen du. |
| Anthropic-rekin bateragarria den POST /v1/messages | stream onartzen du. |
| POST /embeddings | Ez du streaming-a onartzen. |
| Ivy bilaketa-ereduen familia (ivy-4-mm-search, etab.) | stream aktibatuta egon arren, zerbitzariak desaktibatu eta erantzuna aldi berean bidaltzen du. |
| GET /responses/{responseId}?stream=true | 400 egoerarekin baztertzen da. Bide hori itxita dago atzeko planoko erantzunen erabilera zehazki behin neurtu ahal izan arte. |
Lehen zatiarekin batera, hiru goiburu hauek bidaltzen dira. Ondoren, zati bakoitzean event: lerroa (upstream-ak gertaeraren izena eman badu bakarrik) eta data: lerroa bidaltzen dira, eta berehala flush egiten da.
- Content-Type: text/event-stream
- Cache-Control: no-cache
- X-Accel-Buffering: no
Anthropic-rekin bateragarria den bideko zatiek event lerroa eta data lerroa parekatzen dituzte.
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":"안"}}chat/completions-eko zatiak data lerroen bidez iristen dira, eta amaieran data: [DONE] bere horretan helarazten da.
data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[...]}
data: [DONE]Ahotsaren eta voice bideen
TTS, STT eta Cosa ahotsak kudeatzeko bideak OpenAI-rekin bateragarria den zehaztapenaren barruan daude, eta ohiko inferentziaren aldean hainbat arau desberdin dituzte. Eredu bakoitzak zein bide onartzen duen modeloen orriko Cosa taulan dago.
| Metodoa | Bidea | Deskribapena |
|---|---|---|
| POST | /api/v2/aiservice/openai/v1/audio/speech | Testua ahots bihurtu eta audioa zuzenean deskargatzen du. |
| POST | /api/v2/aiservice/openai/v1/audio/transcriptions | Audioa testura transkribatzen du (multipart). |
| POST | /api/v2/aiservice/openai/v1/audio/speech/clone | Ahots klonatuarekin ahotsa sintetizatzen du (multipart). |
| GET | /api/v2/aiservice/openai/v1/voices | Erabil ditzakedan ahotsen zerrenda. |
| POST | /api/v2/aiservice/openai/v1/voices | Ahots bat erregistratzen du audio-lagin batekin (multipart). |
| POST | /api/v2/aiservice/openai/v1/voices/design | Ahots sintetiko bat sortzen du deskribapen batekin. |
| DELETE | /api/v2/aiservice/openai/v1/voices/{voiceId} | Ahotsa ezabatzen du. Jabeek soilik egin dezakete. |
| Araua | Edukia |
|---|---|
| Bitaren entrega | audio/speech, audio/speech/clone, outputs/{filename} helbideen erantzun arrakastatsuak audioa zuzenean igortzen du eta, aldi berean, CleviDrive-en gordetzen du. |
| Ordainagiriaren goiburuak | X-Clevi-Drive-File-Id, X-Clevi-Drive-File-Version-Id, X-Clevi-Drive-Download-Url, X-Clevi-Drive-Expires-At, X-Clevi-Drive-Retention-Days: 3 itzultzen dira. Atxikipen-epea 3 egunekoa da, eta ondoren 404 itzultzen da. |
| Product hautatzea | audio/speech eta audio/transcriptions zerbitzuek gorputzeko model erabiliz hautatzen dute Product. Ahots- eta diagnostiko-bideek X-Product-Sku goiburua edo product_sku kontsulta-parametroa behar dute. |
| Ahotsen jabetza | Klonatutako eta erregistratutako ahotsak sortu dituen erakundearenak dira. Beste norbaiten ahotsarekin sintetizatzen edo ahotsa ezabatzen saiatuz gero, 403 itzultzen da, eta GET /voices zerrendan ere erabiltzailearen beraren ahotsak baino ez dira agertzen. |
| Tamaina eta denbora | Eskaeraren gehieneko tamaina 28 MiB da, eta gorako zerbitzurako deiaren denbora-muga 5 minutukoa da. |
| provider-en pilaketa | Gorako zerbitzua lanpetuta badago, 409 zuzenean igortzen da, eta Retry-After ematen badu, balio hori ere igortzen da. Pasabideak ez du berriro saiatzen, ezta eskaera ilaran jartzen ere. |
