Developer guide
Fanamarinana amin'ny API key
Header hampidirana ny API key sy ny base URL hapetraka ao amin'ny SDK
Ity pejy ity dia manazava ny fomba fanamarinana amin'ny API key ao amin'ny vavahadin'ny CLEVI.
Samy mampiasa key iray ny lalana mifanaraka amin'ny OpenAI sy ny lalana mifanaraka amin'ny Anthropic,
fa samy hafa arakaraka ny fepetra ny faritra azo ampiasana ny header misy ny key sy ny base URL hapetraka ao amin'ny SDK.
Header fanamarinana
Samy manamarina amin'ny API key iray ireo fepetra roa mifanaraka ireo. Omena ao amin'ny pejin'ny API keys ao amin'ny console ny key, ary ao amin'io pejy io ihany koa no itantanana ny fanafoanana sy ny faritra azo ampiasana azy.
| Header | Mifanaraka amin'ny OpenAI | Mifanaraka amin'ny Anthropic |
|---|---|---|
| X-API-Key: <키> | Azo ampiasaina | Azo ampiasaina |
| Authorization: Bearer <키> | Azo ampiasaina | Azo ampiasaina |
| Authorization: <키> (tsy misy Bearer) | Lavina | Azo ampiasaina |
Tsy manavaka sora-baventy sy sora-malefaka ny anaran'ny header. Miasa toy izao ihany koa ny x-api-key alefan'ny Anthropic SDK.
base URL
Ny SDK nampiasainao dia mbola hiasa raha ovaina ho amin'ireo adiresy etsy ambany ihany ny base URL. Ny fahasamihafan'ireo adiresy roa dia ny fisian'ny /v1 na tsia.
| Fepetra | base URL | Fitsipiky ny lalana |
|---|---|---|
| Mifanaraka amin'ny OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Ampidiro ao amin'ny base URL hatramin'ny /v1. |
| Mifanaraka amin'ny Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Ny Anthropic SDK no manampy ho azy ny /v1 ao amin'ny lalana, ka mifarana alohan'ny /v1. |
Fanamarinana ny fanamarinana
Rehefa ampidirinao ny key sy ny base URL ary alaina ny lisitry ny modely, dia ho fantatra avy hatrany raha voamarina ianao. Ireto telo etsy ambany ireto dia manao ilay fakana mitovy amin'ny curl, OpenAI SDK ary Anthropic SDK.
curl https://platform.clevi.net/api/v2/aiservice/openai/v1/models \
-H "X-API-Key: sk-..."
curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/models \
-H "Authorization: Bearer sk-..." \
-H "anthropic-version: 2023-06-01"from openai import OpenAI
client = OpenAI(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/openai/v1",
)
for model in client.models.list():
print(model.id)from anthropic import Anthropic
client = Anthropic(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/anthropic",
)
for model in client.models.list(limit=20).data:
print(model.id)Ao amin'ny toeran'ny sk-... dia ampidiro ny key nomena tao amin'ny pejin'ny API keys.
- Raha 200 ny valiny dia voamarina ny fanamarinana. Ao amin'ny data no misy ny lisitry ny modely azo antsoina amin'ity key ity.
- Raha 401 ny valiny dia jereo araka ny filaharana ao amin'ny fizarana momba ny tsy fahombiazan'ny fanamarinana etsy ambany.
Header ampiasaina miaraka
Safidy avokoa ireo. Raha te hanara-maso olana, tsara ny mampiditra X-Request-Id.
| Lohateny | Fampiasana | Raha avela |
|---|---|---|
| X-Request-Id | Famantarana ampiasaina hanarahana ny fangatahana. Amin'ny valinteny mifanaraka amin'i Anthropic, dia averina ho lohateny request-id izy. | Ny mpizara no mamoaka azy. |
| X-Region-Code | Faritra iantsoana | global izy. |
| X-Product-Sku (azo ampiasaina koa amin'ny product_sku ao amin'ny query) | Manondro mivantana ny Product SKU hampiasaina amin'ny faktiora. Ny lohateny no manana laharam-pahamehana noho ny query, ary ampiasaina indrindra amin'ny lalan'ny feo/voice. | Ilaina amin'ny lalan'ny voice. Ny audio/speech sy audio/transcriptions dia misafidy ny Product amin'ny model ao amin'ny vatana. |
| anthropic-version / anthropic-beta | Ampitaina tsy miova amin'ny lalan'ny fifanarahana amin'i Anthropic. | 2023-06-01 ny dikan-teny. |
Tsy nahomby ny fanamarinana
Raha tsy misy fanalahidy na mandefa fanalahidy lany daty na nofoanana ianao, dia 401 no valiny. Raha miantso tsy misy fanalahidy amin'ny lalan'ny fifanarahana amin'i OpenAI, dia miseho ny vatana etsy ambany, ary ny error.type ao amin'ny lalan'ny fifanarahana amin'i Anthropic dia authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Hamarino ao amin'ny pejin'ny fanalahidin'ny API ny satan'ny fanalahidy. Raha lany daty na nofoanana ilay izy, mamoròna vaovao.
- Hamarino raha X-API-Key na Authorization no anaran'ny lohateny.
- Raha mampiasa Authorization amin'ny lalan'ny fifanarahana amin'i OpenAI, hamarino ny tovona Bearer.
