Dilysu gyda allwedd API

Mae porth CLEVI yn dilysu’r llwybr sy’n gydnaws ag OpenAI a’r llwybr sy’n gydnaws ag Anthropic gydag un allwedd API.
Y ddau werth i’w gosod yn y cleient yw’r pennyn dilysu sy’n cynnwys yr allwedd a base URL y SDK, ac mae’r fformatau pennyn a’r base URL a ganiateir yn wahanol yn ôl y fanyleb.
Ar ôl cwblhau’r gosodiad, gallwch gadarnhau’r dilysiad ar unwaith drwy nôl rhestr y modelau.
Os bydd y dilysiad yn methu, dychwelir 401; os na chaiff amodau awdurdodi neu derfyn eu bodloni ar ôl pasio’r dilysiad, dychwelir 403.

Cyhoeddwch allwedd API o sgrin allweddi API y consol. Gallwch hefyd reoli dirymu’r allwedd a’i chwmpas defnydd ar yr un sgrin.

Pennyn dilysu

Mae’r ddwy fanyleb yn cynnwys yr allwedd API mewn un pennyn cais. Defnyddiwch naill ai’r pennyn X-API-Key neu’r pennyn Authorization; mae’r fformat a ganiateir yn dibynnu ar y fanyleb.

Wrth ddefnyddio’r pennyn Authorization yn y llwybr sy’n gydnaws ag OpenAI, mae angen y rhagddodiad Bearer. Os anfonwch yr allwedd yn unig heb y rhagddodiad, bydd y porth yn gwrthod y cais.

Nid yw enwau penynnau’n sensitif i lythrennau mawr a bach, felly mae’r pennyn x-api-key a anfonir gan Anthropic SDK hefyd yn gweithio fel y mae. Os nodir y ddau bennyn, rhoddir blaenoriaeth i werth X-API-Key.

base URL

Gallwch barhau i ddefnyddio’r SDK a ddefnyddiwyd gennych o’r blaen drwy newid base URL yn unig i’r cyfeiriad isod. Mae’r ddau gyfeiriad yn wahanol o ran a ydynt yn cynnwys /v1, felly nodwch y cyfeiriad sy’n cyfateb i’r fanyleb yn union.

Cadarnhau dilysiad

Ar ôl gosod yr allwedd a'r URL sylfaen, gallwch wirio a oes dilysiad drwy ymholi'r rhestr o fodelau. Mae'r enghreifftiau isod yn gweithredu'r un ymholiad gan ddefnyddio curl, OpenAI SDK, ac Anthropic SDK. Yn lle sk-... rhowch yr allwedd a gyhoeddwyd ar sgrin API Keys.

Wrth ymholi gan ddefnyddio curl, nodwch y llwybr llawn hyd at /v1/models ar gyfer y ddwy fanyleb. Mae'r gorchymyn cyntaf yn defnyddio pennawd X-API-Key ar gyfer y llwybr sy'n gydnaws ag OpenAI, ac mae'r ail orchymyn yn defnyddio pennawd Authorization ar gyfer y llwybr sy'n gydnaws ag 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"

Mae OpenAI SDK yn nodi cyfeiriad sy'n cynnwys /v1 yn 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)

Mae Anthropic SDK yn nodi base_url gyda'r cyfeiriad yn dod i ben cyn /v1.
Ar gyfer dilysu, defnyddiwch bennawd x-api-key a anfonir gan y SDK fel y mae.

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)

Os yw'r ymateb yn 200 mewn unrhyw enghraifft, mae'r dilysiad wedi llwyddo, ac mae'r rhestr o fodelau y gellir eu galw gyda'r allwedd hon wedi'i chynnwys yn data yr ymateb. Os mai 401 yw'r ymateb, gwiriwch yr achos yn y drefn yn yr adran nesaf.

Methiant dilysu

Os anfonir allwedd sydd ar goll, wedi dod i ben neu wedi'i dirymu, dychwelir 401. Os gwneir galwad heb allwedd ar y llwybr sy'n gydnaws ag OpenAI, dychwelir y corff isod; ar y llwybr sy'n gydnaws ag Anthropic, error.type yw authentication_error.

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

Os cewch 401, gwiriwch yn y drefn ganlynol.

1. Gwiriwch statws yr allwedd ar sgrin API Keys. Os yw wedi dod i ben neu wedi'i dirymu, cyhoeddwch un newydd.
2. Gwiriwch mai X-API-Key neu Authorization yw enw'r pennawd.
3. Os ydych yn defnyddio pennawd Authorization ar y llwybr sy'n gydnaws ag OpenAI, gwiriwch a oes rhagddodiad Bearer.

Ar ôl gwneud y newidiadau, gweithredwch ymholiad y rhestr o fodelau yn yr adran gwirio dilysu eto a chadarnhewch eich bod yn cael 200.

Penawdau a ddefnyddir gyda'i gilydd

Mae'r holl benawdau canlynol yn ddewisol. Er mwyn olrhain problemau, rydym yn argymell pennu X-Request-Id.

Os bydd 5xx yn digwydd dro ar ôl tro, rhowch wybod i ni drwy'r cymorth a'r ffurflen gyswllt, ynghyd â X-Request-Id. Os mai gwerth a bennwyd yn uniongyrchol ydyw, gellir ei gymharu'n uniongyrchol â chofnodion y cleient.