Whakamana mā te kī API

Ka whakamana te kēti CLEVI i ngā ara hototahi ki OpenAI me ngā ara hototahi ki Anthropic mā te kī API kotahi.
E rua ngā uara hei whakarite ki te kiritaki: te pane whakamana kei roto te kī me te URL taketake o te SDK, ā, he rerekē ngā momo pane me ngā URL taketake e whakaaetia ana mō ia paerewa.
Whai muri i te whakarite, ka taea te whakaū wawe i te whakamana mā te tiki i te rārangi tauira.
Mēnā ka rahua te whakamana, ka whakahokia te 401; mēnā ka tutuki te whakamana engari kāore e tutuki ngā tikanga mō ngā whakaaetanga, mō ngā rohe rānei, ka whakahokia te 403.

Tukuna he kī API mai i te whārangi API Keys i te papatohu. I taua whārangi anō ka taea te whakahaere i te whakakore i te kī me tōna whānuitanga whakamahinga.

Pane whakamana

Ka whakaurua e ngā paerewa e rua te kī API ki roto i te pane kotahi o te tono. Ka whakamahi i te pane X-API-Key, i te pane Authorization rānei, ā, ka rerekē te momo e whakaaetia ana i runga i te paerewa.

Ina whakamahi i te pane Authorization i te ara hototahi ki OpenAI, me whai te pūmua Bearer. Mēnā ka tukuna ko te kī anake me te kore o te pūmua, ka whakakāhoretia e te kēti te tono.

Kāore e aro te ingoa pane ki te pū matua me te pū iti, nō reira ka mahi tonu te pane x-api-key e tukuna ana e te SDK Anthropic. Mēnā ka whakaritea ngā pane e rua, ka whakamahia tuatahi te uara X-API-Key.

URL taketake

Ka taea te whakamahi tonu i te SDK kua whakamahia kētia mā te huri noa i te URL taketake ki ngā wāhitau kei raro nei. He rerekē ngā wāhitau e rua mēnā ka whakaurua te /v1, nō reira whakaritea te wāhitau e hāngai ana ki te paerewa kia rite tonu.

Whakaū whakamana

Whai muri i te whakarite i te kī me te base URL, ka taea e koe te tirotiro mēnā kua whakamana mā te tiki i te rārangi tauira. Ko ngā tauira kei raro nei ka whakahaere i taua tiki mā te curl, OpenAI SDK, me Anthropic SDK. Whakakapia te wāhi sk-... ki te kī i hangaia i te mata API key.

Ina tiki mā te curl, whakapūtā te ara katoa tae atu ki /v1/models mō ngā whakaritenga e rua. Ka whakamahi te whakahau tuatahi i te pane X-API-Key mō te ara hototahi ki OpenAI, ā, ka whakamahi te whakahau tuarua i te pane Authorization mō te ara hototahi ki 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"

Mā te OpenAI SDK, whakapūtā he wāhitau kei roto ko /v1 i te 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)

Mā te Anthropic SDK, whakapūtā he wāhitau ka mutu i mua i te /v1 ki te base_url.
Mō te whakamana, whakamahia tonu te pane x-api-key ka tukuna e te 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)

Mēnā he 200 te whakautu i ngā tauira katoa, kua angitu te whakamana, ā, kei roto i te data o te whakautu te rārangi tauira ka taea te karanga mā tēnei kī. Mēnā he 401, tirohia te take mā te raupapa kei te wāhanga e whai ake nei.

I rahua te whakamana

Mēnā kāore he kī, mēnā rānei ka tukuna he kī kua pau, kua whakakorehia rānei, ka whakahokia te 401. Ina karangahia te ara hototahi ki OpenAI me te kore kī, ka whakahokia te tinana kei raro nei, ā, mō te ara hototahi ki Anthropic, ko authentication_error te error.type.

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

Mēnā ka whiwhi koe i te 401, tirohia ngā mea e whai ake nei i tēnei raupapa.

1. Tirohia te tūnga o te kī i te mata API key. Mēnā kua pau, kua whakakorehia rānei, hangaia he kī hou.
2. Tirohia mēnā ko X-API-Key, ko Authorization rānei te ingoa o te pane.
3. Mēnā ka whakamahi koe i te pane Authorization i te ara hototahi ki OpenAI, tirohia mēnā kei reira te kuhimua Bearer.

Whai muri i te whakatika, whakahaere anō i te tiki rārangi tauira i te wāhanga whakamana, ka tirohia mēnā ka tae mai he 200.

Ngā pane ka whakamahia ngātahi

He kōwhiringa katoa ngā pane e whai ake nei. E tūtohu ana mātou kia tautuhia a X-Request-Id kia māmā ai te whai i ngā raru.

Ki te tāruarua ngā 5xx, whakamōhio mai mā te Āwhina me te Whakapā, me te X-Request-Id. Mēnā nāu tonu te uara i tautuhi, ka taea te whakataurite tonutia ki ngā rekoata a te kiritaki.