Hōʻoia me ke kī API

Hoʻohana ka ʻīpuka CLEVI i hoʻokahi kī API no ka hōʻoia ʻana i nā ala i kūlike me OpenAI a me nā ala i kūlike me Anthropic.
ʻElua wale nō waiwai e hoʻonohonoho ai ma ka mea kūʻai: ke poʻo hōʻoia e paʻa ai ke kī a me ka base URL o ka SDK, a ʻokoʻa nā ʻano poʻo i ʻae ʻia a me ka base URL ma muli o ka maʻamau.
Ma hope o ka hoʻopau ʻana i ka hoʻonohonoho, hiki iā ʻoe ke hōʻoia koke i ka holomua o ka hōʻoia ma ka kiʻi ʻana i ka papa inoa o nā model.
Inā hāʻule ka hōʻoia, hoʻihoʻi ʻia ka 401; inā ua hala ka hōʻoia akā ʻaʻole i hoʻokō ʻia nā kūlana ʻae a i ʻole ka palena, hoʻihoʻi ʻia ka 403.

E hoʻopuka i kāu kī API ma ka ʻaoʻao API keys o ka console. Ma ia ʻaoʻao hoʻokahi nō e hiki ai iā ʻoe ke hoʻokele i ka hoʻopau ʻana i ke kī a me ka laulā o kona hoʻohana ʻana.

Poʻo hōʻoia

Hoʻokomo nā maʻamau ʻelua i ke kī API i loko o hoʻokahi poʻo noi. E hoʻohana i ke poʻo X-API-Key a i ʻole ke poʻo Authorization, a ʻokoʻa ke ʻano i ʻae ʻia ma muli o ka maʻamau.

Ke hoʻohana ʻia ke poʻo Authorization ma ke ala i kūlike me OpenAI, pono ka prefix Bearer. Inā hoʻouna wale ʻia ke kī me ka ʻole o ka prefix, e hōʻole ka ʻīpuka i ka noi.

ʻAʻole nānā ka inoa o ke poʻo i ka ʻokoʻa o nā hua nui a me nā hua liʻiliʻi, no laila hana pū ke poʻo x-api-key i hoʻouna ʻia e ka Anthropic SDK me ka hoʻololi ʻole. Inā kuhikuhi ʻia nā poʻo ʻelua, e hoʻohana mua ʻia ka waiwai o X-API-Key.

base URL

Hiki ke hoʻohana mau ʻia ka SDK i hoʻohana ʻia ma mua ma ka hoʻololi wale ʻana i ka base URL i kekahi o nā helu wahi ma lalo. ʻO ka ʻokoʻa ma waena o nā helu wahi ʻelua, ʻo ia ka hoʻokomo ʻia ʻana o /v1 a ʻaʻole paha, no laila e kuhikuhi pololei i ka helu wahi i kūlike me ka maʻamau.

Hōʻoia i ka hōʻoia ʻana

Ma hope o ka hoʻonohonoho ʻana i ke kī a me ka base URL, hiki iā ʻoe ke nānā i ka papa inoa o nā model e hōʻoia ai i ka hōʻoia ʻike. Hoʻohana ka laʻana ma lalo i ka curl, OpenAI SDK, a me Anthropic SDK no ka nānā like ʻana. Ma kahi o sk-..., e hoʻokomo i ke kī i hoʻopuka ʻia ma ka ʻaoʻao kī API.

Ke nānā me ka curl, e kuhikuhi i ke ala holoʻokoʻa a hiki i /v1/models no nā ʻano ʻelua. Hoʻohana ke kauoha mua i ke poʻomanaʻo X-API-Key no ke ala kūlike me OpenAI, a hoʻohana ke kauoha ʻelua i ke poʻomanaʻo Authorization no ke ala kūlike me Anthropic.

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"

No OpenAI SDK, e kuhikuhi i kahi helu wahi i hoʻokomo ʻia ka /v1 i loko o base_url.

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)

No Anthropic SDK, e kuhikuhi i ka base_url i pau ma mua o /v1.
No ka hōʻoia ʻike, hoʻohana pololei i ke poʻomanaʻo x-api-key i hoʻouna ʻia e ka SDK.

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)

Inā he 200 ka pane o kekahi laʻana, ua holomua ka hōʻoia ʻike, a aia i loko o ka data o ka pane ka papa inoa o nā model i hiki ke kāhea ʻia me kēia kī. Inā he 401, e nānā i ke kumu ma ke kaʻina i ka paukū aʻe.

Ua hāʻule ka hōʻoia ʻike

Inā hoʻouna ʻia ke kī ʻole, a i ʻole he kī i pau ka mana a i hoʻopau ʻia paha, e hoʻihoʻi ʻia ka 401. Inā kāhea ʻia ke ala kūlike me OpenAI me ke kī ʻole, e hoʻihoʻi ʻia ke kino ma lalo; ma ke ala kūlike me Anthropic, ʻo authentication_error ka waiwai o error.type.

{
  "error": {
    "message": "API key is required.",
    "type": "invalid_request_error"
  }
}

Inā loaʻa ka 401, e nānā ma kēia kaʻina.

1. E nānā i ke kūlana o ke kī ma ka ʻaoʻao kī API. Inā ua pau ka mana a ua hoʻopau ʻia paha ke kī, e hoʻopuka hou i kekahi kī.
2. E hōʻoia inā ʻo X-API-Key a i ʻole Authorization ka inoa o ke poʻomanaʻo.
3. Inā hoʻohana ʻia ke poʻomanaʻo Authorization ma ke ala kūlike me OpenAI, e hōʻoia aia ka unuhi mua Bearer.

Ma hope o ka hoʻoponopono ʻana, e holo hou i ka nānā ʻana i ka papa inoa o nā model ma ka paukū hōʻoia ʻike a e hōʻoia inā loaʻa ka 200.

Nā poʻomanaʻo e hoʻohana pū ʻia

He koho wale nō nā poʻomanaʻo a pau ma lalo. Paipai mākou e hoʻonohonoho i ka X-Request-Id i hiki ke huli i nā pilikia.

Inā hoʻi pinepine mai nā hewa 5xx, e hōʻike mai iā mākou ma o ke Kōkua a me ka Hoʻokaʻaʻike, me ka X-Request-Id. Inā he waiwai āu i指定 pololei ai, hiki ke hoʻohālikelike koke ʻia me nā moʻolelo o ka mea kūʻai.