Developer guide
Te whakamana mā te kī API
Te pane hei whakauru i te kī API me te base URL hei tautuhi ki te SDK
Kei tēnei whārangi ngā kōrero mō te whakamana ki te kēti CLEVI mā te kī API.
Mā te kī kotahi te whakamana mō ngā ara e rua, ko te ara hototahi ki OpenAI me te ara hototahi ki Anthropic,
engari he rerekē te whānuitanga e whakaaetia ana mō te pane whai kī me te base URL hei tautuhi ki te SDK mō ia paerewa.
Pane whakamana
Mā te kī API kotahi te whakamana mō ngā paerewa hototahi e rua. Ka tukuna te kī ki te mata API keys o te papatohu, ā, ka whakahaerehia hoki te whakakore me te whānuitanga whakamahinga ki taua mata anō.
| Pane | Hototahi ki OpenAI | Hototahi ki Anthropic |
|---|---|---|
| X-API-Key: <키> | Ka taea te whakamahi | Ka taea te whakamahi |
| Authorization: Bearer <키> | Ka taea te whakamahi | Ka taea te whakamahi |
| Authorization: <키> (me te kore Bearer) | Ka whakakorehia | Ka taea te whakamahi |
Kāore te ingoa pane e aro ki te pūriki, pūmatua rānei. Ka mahi tonu te x-api-key ka tukuna e te SDK Anthropic.
base URL
Ka mahi tonu te SDK e whakamahia ana ina whakarerekēhia te base URL ki te wāhitau kei raro nei. He rerekē ngā wāhitau e rua mō te whakauru, kāore rānei i te whakauru, i te /v1.
| Paerewa | base URL | Ture ara |
|---|---|---|
| Hototahi ki OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Whakaurua te /v1 ki te base URL. |
| Hototahi ki Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Ka tāpiri a Anthropic SDK i te /v1 ki te ara, nō reira ka mutu i mua i te /v1. |
Te manatoko whakamana
Mā te whakauru i te kī me te base URL, kātahi ka tiki i te rārangi tauira, ka mōhio tonu koe mēnā kua whakamanahia. Kei raro nei, ka mahia taua tiki kotahi mā curl, OpenAI SDK me 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)Ki te wāhi sk-... , whakaurua te kī i tukuna mai i te mata API keys.
- Mēnā he 200 te urupare, kua whakamanahia. Kei roto i te data te rārangi tauira ka taea e tēnei kī te karanga.
- Mēnā he 401 te urupare, tirohia mā te raupapa kei te wāhanga rahunga whakamana kei raro nei.
Ngā pane whakamahia ngātahitia
He kōwhiringa katoa ēnei. Hei whai i te raru, he pai ake te whakauru i X-Request-Id.
| Pane | Whakamahinga | Ki te waiho kia kore e whakaurua |
|---|---|---|
| X-Request-Id | He pūtautuhi hei whai i te tono. I ngā whakautu e hototahi ana ki Anthropic, ka whakahokia hei pane request-id. | Mā te tūmau e tuku. |
| X-Region-Code | Te rohe karanga | Ko global. |
| X-Product-Sku (ka taea hoki mā te product_sku uiui) | Ka tautuhi tika i te Product SKU hei whakamahi mō te nama. He mea matua ake te pane i te uiui, ā, ka whakamahia te nuinga i ngā ara reo me te ara voice. | E hiahiatia ana i ngā ara voice. I audio/speech me audio/transcriptions, ka kōwhiria te Product mā te model o te tinana. |
| anthropic-version / anthropic-beta | Ka tukuna tonutia i ngā ara e hototahi ana ki Anthropic. | Ko te putanga ko 2023-06-01. |
I rahua te motuhēhēnga
Mēnā kāore he kī, ka tukuna rānei he kī kua pau, kua whakakorehia rānei, ko 401 te hua. Ki te karanga mā te ara e hototahi ana ki OpenAI me te kore kī, ka puta te tinana kei raro nei, ā, ko authentication_error te error.type i te ara e hototahi ana ki Anthropic.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Tirohia te tūnga o te kī i te mata API key. Ki te mea kua pau, kua whakakorehia rānei, tukuna he kī hou.
- Tirohia mēnā ko X-API-Key, ko Authorization rānei te ingoa o te pane.
- Mēnā ka whakamahi i Authorization i te ara e hototahi ana ki OpenAI, tirohia te pūmua Bearer.
