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 denaEstandarraBidea
Elkarrizketa-inferentzia, OpenAI SDK erabiltzeaOpenAI-rekin bateragarriaPOST /chat/completions edo POST /responses
Elkarrizketa-inferentzia, Anthropic SDK erabiltzeaAnthropic-rekin bateragarriaPOST /v1/messages
Embedding-ak sortzeaOpenAI-rekin bateragarriaPOST /embeddings
Ahots-sintesia eta transkripzioa, voice-en kudeaketaOpenAI-rekin bateragarria/audio eta /voices azpiko bideak
Dei daitezkeen modeloak egiaztatzeaBiakGET /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.

MetodoaBideaAzalpena
POST/api/v2/aiservice/openai/v1/chat/completionsElkarrizketa bidezko arrazoiketa. stream gaituz gero, SSE bidez erantzuten du.
POST/api/v2/aiservice/openai/v1/responsesResponses 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_itemsGordetako erantzunaren sarrera-elementuen zerrenda da.
POST/api/v2/aiservice/openai/v1/responses/{responseId}/cancelAtzeko 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/completionsTestuaren osatze legatua. stream onartzen du.
POST/api/v2/aiservice/openai/v1/embeddingsEmbedding-a sortzen du. Ez du streaming-a onartzen.
GET/api/v2/aiservice/openai/v1/modelsGako 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

BideaAzalpena
GET /api/v2/aiservice/openai/v1/healthzAhots-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.

MetodoaBideaDeskribapena
POST/api/v2/aiservice/anthropic/v1/messagesMessages zehaztapenaren araberako deia. model, messages eta max_tokens behar dira, eta stream onartzen du.
POST/api/v2/aiservice/anthropic/v1/messages/count_tokensSarrerako token kopurua soilik estimatzen du, kobratu gabe. Ez da max_tokens behar.
GET/api/v2/aiservice/anthropic/v1/modelsEreduen 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.

HelburuaFuntzionamendua
OpenAI-rekin bateragarria den POST /chat/completions · POST /completions · POST /responsesstream onartzen du.
Anthropic-rekin bateragarria den POST /v1/messagesstream onartzen du.
POST /embeddingsEz 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=true400 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.

MetodoaBideaDeskribapena
POST/api/v2/aiservice/openai/v1/audio/speechTestua ahots bihurtu eta audioa zuzenean deskargatzen du.
POST/api/v2/aiservice/openai/v1/audio/transcriptionsAudioa testura transkribatzen du (multipart).
POST/api/v2/aiservice/openai/v1/audio/speech/cloneAhots klonatuarekin ahotsa sintetizatzen du (multipart).
GET/api/v2/aiservice/openai/v1/voicesErabil ditzakedan ahotsen zerrenda.
POST/api/v2/aiservice/openai/v1/voicesAhots bat erregistratzen du audio-lagin batekin (multipart).
POST/api/v2/aiservice/openai/v1/voices/designAhots sintetiko bat sortzen du deskribapen batekin.
DELETE/api/v2/aiservice/openai/v1/voices/{voiceId}Ahotsa ezabatzen du. Jabeek soilik egin dezakete.
Ahotsen eta voice bideen soilik aplikatzen diren arauak
ArauaEdukia
Bitaren entregaaudio/speech, audio/speech/clone, outputs/{filename} helbideen erantzun arrakastatsuak audioa zuzenean igortzen du eta, aldi berean, CleviDrive-en gordetzen du.
Ordainagiriaren goiburuakX-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 hautatzeaaudio/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 jabetzaKlonatutako 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 denboraEskaeraren gehieneko tamaina 28 MiB da, eta gorako zerbitzurako deiaren denbora-muga 5 minutukoa da.
provider-en pilaketaGorako 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.
CLEVI

Hizkuntza eta eskualdea

Makina bidez itzulitako hizkuntzak markatuta daude. Erabilgarritasuna argitaratutako gunearen paketearen araberakoa da.

136 hizkuntza

Gomendatua

1

Ekialdeko Asia

7

Hego-ekialdeko Asia

11

Hego Asia

18

Erdialdeko Asia

5

Ekialde Hurbila eta Kaukasoa

10

Mendebaldeko Europa eta Hego Europa

16

Erresuma Batua eta Irlanda

4

Ipar Europa

10

Erdialdeko Europa eta Balkanak

14

Ekialdeko Europa

5

Ekialdeko Afrika

8

Mendebaldeko Afrika eta Erdialdeko Afrika

9

Hegoaldeko Afrika

8

Amerika

5

Ozeania

5