API түлхүүрээр баталгаажуулах

CLEVI Gateway нь OpenAI-тай нийцтэй зам болон Anthropic-тай нийцтэй замд нэг API түлхүүрээр баталгаажуулалт хийдэг.
Клиентэд тохируулах утга нь түлхүүр агуулсан баталгаажуулалтын толгой хэсэг болон SDK-ийн base URL гэсэн хоёр зүйл бөгөөд зөвшөөрөгдөх толгой хэсгийн формат болон base URL нь стандартаас хамааран ялгаатай байна.
Тохиргоог хийсний дараа моделийн жагсаалтыг авахад баталгаажуулалт хийгдсэн эсэхийг шууд шалгах боломжтой.
Баталгаажуулалт амжилтгүй бол 401, баталгаажуулалтад тэнцсэн боловч эрх эсвэл хязгаарын нөхцөлийг хангаагүй бол 403 буцаана.

API түлхүүрийг консолын API түлхүүрийн дэлгэцээс үүсгэнэ үү. Та мөн уг дэлгэцээс түлхүүрийг хүчингүй болгох болон ашиглах хүрээг удирдах боломжтой.

Баталгаажуулалтын толгой хэсэг

Хоёр стандартын аль алинд хүсэлтийн нэг толгой хэсэгт API түлхүүрийг оруулна. X-API-Key толгой хэсэг эсвэл Authorization толгой хэсгийн аль нэгийг ашиглах бөгөөд зөвшөөрөгдөх формат нь стандартаас хамааран ялгаатай байна.

OpenAI-тай нийцтэй замд Authorization толгой хэсгийг ашиглах үед Bearer угтвар шаардлагатай. Угтваргүйгээр зөвхөн түлхүүр илгээвэл Gateway хүсэлтийг татгалзана.

Толгой хэсгийн нэр том, жижиг үсгийг ялгадаггүй тул Anthropic SDK-ээс илгээдэг x-api-key толгой хэсэг мөн шууд ажиллана. Хоёр толгой хэсгийг хоёуланг нь заасан бол X-API-Key-ийн утгыг давуу хэрэглэнэ.

base URL

Өмнө ашиглаж байсан SDK-ийг base URL-ийг доорх хаягаар солиход хэвээр нь ашиглаж болно. Хоёр хаяг нь /v1-г багтаасан эсэхээрээ ялгаатай тул стандартад тохирох хаягийг яг хэвээр нь тохируулна уу.

Баталгаажуулалтыг шалгах

Түлхүүр болон base URL-ийг тохируулсны дараа загваруудын жагсаалтыг авснаар баталгаажуулалт хийгдсэн эсэхийг шалгах боломжтой. Доорх жишээнүүд ижил хүсэлтийг curl, OpenAI SDK, Anthropic SDK ашиглан гүйцэтгэнэ. sk-... байрлалд API түлхүүрийн дэлгэцээс олгосон түлхүүрийг оруулна уу.

curl ашиглан жагсаалтыг авахдаа хоёр форматын хувьд хоёуланд нь /v1/models хүртэлх бүрэн замыг заана. Эхний тушаал нь OpenAI-тэй нийцтэй замд X-API-Key толгойг, хоёр дахь тушаал нь Anthropic-тэй нийцтэй замд Authorization толгойг ашиглана.

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"

OpenAI SDK-ийн хувьд base_url-д /v1-ийг багтаасан хаягийг заана.

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)

Anthropic SDK-ийн хувьд base_url-ийг /v1-ийн өмнө дуусахаар заана.
Баталгаажуулалтад SDK-ээс илгээдэг x-api-key толгойг хэвээр нь ашиглана.

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)

Аль ч жишээнд хариу 200 байвал баталгаажуулалт амжилттай болсон гэсэн үг бөгөөд хариуны data талбарт энэ түлхүүрээр дуудаж болох загваруудын жагсаалт агуулагдана. 401 гарвал дараагийн хэсэгт заасан дарааллаар шалтгааныг шалгана уу.

Баталгаажуулалт амжилтгүй болсон

Түлхүүр байхгүй эсвэл хугацаа нь дууссан, хүчингүй болгосон түлхүүр илгээвэл 401 буцаана. OpenAI-тэй нийцтэй замд түлхүүргүй дуудлага хийхэд доорх биеийг буцаах бөгөөд Anthropic-тэй нийцтэй замд error.type нь authentication_error байна.

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

401 авбал дараах дарааллаар шалгана уу.

1. API түлхүүрийн дэлгэцээс түлхүүрийн төлөвийг шалгана уу. Хугацаа нь дууссан эсвэл хүчингүй болсон түлхүүр бол шинээр олгоно уу.
2. Толгойн нэр нь X-API-Key эсвэл Authorization эсэхийг шалгана уу.
3. OpenAI-тэй нийцтэй замд Authorization толгой ашиглаж байгаа бол Bearer угтвар байгаа эсэхийг шалгана уу.

Засвар хийсний дараа баталгаажуулалтын хэсгийн загваруудын жагсаалт авах үйлдлийг дахин ажиллуулж, 200 ирж байгаа эсэхийг шалгана уу.

Хамт ашиглах толгойнууд

Дараах толгойнууд бүгд сонголттой. Асуудлыг мөрдөх боломжтой байлгахын тулд X-Request-Id-ийг зааж өгөхийг зөвлөж байна.

Raha miverimberina ny 5xx, ampahafantaro anay amin'ny alalan'ny fanampiana sy ny fifandraisana, miaraka amin'ny X-Request-Id. Raha sanda nofaritanao mivantana izy io, dia azo ampitahaina avy hatrany amin'ny firaketana ao amin'ny mpanjifa.