Developer guide

ການຢືນຢັນຕົວຕົນດ້ວຍ API key

Header ສຳລັບໃສ່ API key ແລະ base URL ທີ່ຕ້ອງຕັ້ງຄ່າໃນ SDK

ໜ້ານີ້ອະທິບາຍວິທີຢືນຢັນຕົວຕົນດ້ວຍ API key ກັບ CLEVI gateway.
ທັງເສັ້ນທາງທີ່ຮອງຮັບ OpenAI ແລະເສັ້ນທາງທີ່ຮອງຮັບ Anthropic ໃຊ້ key ດຽວກັນໃນການຢືນຢັນຕົວຕົນ,
ແຕ່ຂອບເຂດທີ່ອະນຸຍາດຂອງ Header ສຳລັບໃສ່ key ແລະ base URL ທີ່ຕ້ອງຕັ້ງຄ່າໃນ SDK ຈະແຕກຕ່າງກັນຕາມຂໍ້ກຳນົດ.

Authentication header

ທັງສອງຂໍ້ກຳນົດທີ່ຮອງຮັບໃຊ້ API key ດຽວກັນໃນການຢືນຢັນຕົວຕົນ. key ສາມາດອອກໄດ້ຈາກໜ້າ API key ໃນຄອນໂຊນ ແລະສາມາດຈັດການການຍົກເລີກແລະຂອບເຂດການໃຊ້ງານໄດ້ຈາກໜ້າດຽວກັນ.

Headerຮອງຮັບ OpenAIຮອງຮັບ Anthropic
X-API-Key: <ຄີ>ໃຊ້ໄດ້ໃຊ້ໄດ້
Authorization: Bearer <ຄີ>ໃຊ້ໄດ້ໃຊ້ໄດ້
Authorization: <ຄີ> (ບໍ່ມີ Bearer)ປະຕິເສດໃຊ້ໄດ້

ຊື່ Header ບໍ່ຈຳກັດຕົວພິມໃຫຍ່-ນ້ອຍ. x-api-key ທີ່ Anthropic SDK ສົ່ງກໍໃຊ້ງານໄດ້ຕາມເດີມ.

base URL

SDK ທີ່ທ່ານໃຊ້ຢູ່ສາມາດໃຊ້ຕໍ່ໄດ້ໂດຍປ່ຽນສະເພາະ base URL ເປັນທີ່ຢູ່ດ້ານລຸ່ມ. ທີ່ຢູ່ສອງອັນແຕກຕ່າງກັນທີ່ວ່າມີ /v1 ລວມຢູ່ຫຼືບໍ່.

ຂໍ້ກຳນົດbase URLກົດການຂອງເສັ້ນທາງ
ຮອງຮັບ OpenAIhttps://platform.clevi.net/api/v2/aiservice/openai/v1ລວມ /v1 ໄວ້ໃນ base URL.
ຮອງຮັບ Anthropichttps://platform.clevi.net/api/v2/aiservice/anthropicAnthropic SDK ຈະເພີ່ມ /v1 ໃສ່ເສັ້ນທາງໃຫ້ເອງ, ດັ່ງນັ້ນຈຶ່ງສິ້ນສຸດກ່ອນ /v1.

ການກວດສອບການຢືນຢັນຕົວຕົນ

ໃສ່ key ແລະ base URL ແລ້ວດຶງລາຍການໂມເດວ, ທ່ານຈະຮູ້ໄດ້ທັນທີວ່າການຢືນຢັນຕົວຕົນສຳເລັດຫຼືບໍ່. ສາມຕົວຢ່າງດ້ານລຸ່ມເຮັດການດຶງລາຍການດຽວກັນດ້ວຍ curl, OpenAI SDK ແລະ 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)

ໃສ່ key ທີ່ອອກຈາກໜ້າ API key ແທນບ່ອນ sk-....

  • ຖ້າຄຳຕອບເປັນ 200 ໝາຍຄວາມວ່າການຢືນຢັນຕົວຕົນສຳເລັດ. data ຈະມີລາຍການໂມເດວທີ່ສາມາດເອີ້ນໃຊ້ດ້ວຍ key ນີ້.
  • ຖ້າຄຳຕອບເປັນ 401 ໃຫ້ກວດສອບຕາມລຳດັບໃນພາກການຢືນຢັນຕົວຕົນລົ້ມເຫຼວດ້ານລຸ່ມ.

Header ທີ່ໃຊ້ຮ່ວມກັນ

ທັງໝົດເປັນທາງເລືອກ. ເພື່ອຕິດຕາມບັນຫາ ຄວນໃສ່ X-Request-Id ໄວ້.

ສ່ວນຫົວຈຸດປະສົງຖ້າລະເວັ້ນ
X-Request-Idຕົວລະບຸສຳລັບຕິດຕາມຄຳຂໍ. ສຳລັບການຕອບກັບທີ່ຮອງຮັບ Anthropic ຈະຖືກສົ່ງກັບເປັນສ່ວນຫົວ request-id.ເຊີບເວີເປັນຜູ້ອອກໃຫ້.
X-Region-Codeຣີຈຽນທີ່ເອີ້ນໃຊ້ແມ່ນ global.
X-Product-Sku (ສາມາດໃຊ້ດ້ວຍ query product_sku ໄດ້)ກຳນົດ Product SKU ທີ່ຈະໃຊ້ສຳລັບການຄິດຄ່າບໍລິການໂດຍກົງ. ສ່ວນຫົວມີບູລິມະສິດເໜືອ query ແລະສ່ວນໃຫຍ່ໃຊ້ໃນເສັ້ນທາງສຽງ·ວອຍຊ໌.ຈຳເປັນໃນເສັ້ນທາງວອຍຊ໌. audio/speech ແລະ audio/transcriptions ເລືອກ Product ຈາກ model ໃນເນື້ອໃນ.
anthropic-version / anthropic-betaຈະຖືກສົ່ງຕໍ່ຕາມເດີມໃນເສັ້ນທາງທີ່ຮອງຮັບ Anthropic.ເວີຊັນແມ່ນ 2023-06-01.

ການຢືນຢັນຕົວຕົນລົ້ມເຫຼວ

ຖ້າບໍ່ມີຄີ ຫຼືສົ່ງຄີທີ່ໝົດອາຍຸ·ຖືກຍົກເລີກ ຈະໄດ້ຮັບ 401. ຖ້າເອີ້ນໃຊ້ໂດຍບໍ່ມີຄີໃນເສັ້ນທາງທີ່ຮອງຮັບ OpenAI ຈະໄດ້ຮັບເນື້ອໃນດ້ານລຸ່ມນີ້ ແລະ error.type ຂອງເສັ້ນທາງທີ່ຮອງຮັບ Anthropic ແມ່ນ authentication_error.

{
  "error": {
    "message": "API key is required.",
    "type": "invalid_request_error"
  }
}
  1. ກວດເບິ່ງສະຖານະຄີຢູ່ໜ້າ API key. ຖ້າຄີໝົດອາຍຸ·ຖືກຍົກເລີກ ໃຫ້ອອກຄີໃໝ່.
  2. ກວດເບິ່ງວ່າຊື່ສ່ວນຫົວແມ່ນ X-API-Key ຫຼື Authorization.
  3. ຖ້າໃຊ້ Authorization ໃນເສັ້ນທາງທີ່ຮອງຮັບ OpenAI ໃຫ້ກວດເບິ່ງຄຳນຳໜ້າ Bearer.
CLEVI

ພາສາ ແລະ ພາກພື້ນ

ພາສາທີ່ແປດ້ວຍເຄື່ອງຈະຖືກໝາຍໄວ້. ຄວາມພ້ອມໃຫ້ໃຊ້ອີງຕາມຊຸດເວັບໄຊທີ່ເຜີຍແຜ່.

136 ພາສາ

ແນະນຳ

1

ອາຊີຕາເວັນອອກ

7

ອາຊີຕາເວັນອອກສຽງໃຕ້

11

ອາຊີໃຕ້

18

ອາຊີກາງ

5

ຕາເວັນອອກກາງ ແລະ ຄໍເຄຊັດ

10

ຢູໂຣບຕາເວັນຕົກ ແລະ ຢູໂຣບໃຕ້

16

ສະຫະລາດຊະອະນາຈັກ ແລະ ໄອແລນ

4

ຢູໂຣບເໜືອ

10

ເອີຣົບກາງ ແລະ ບານຄານ

14

ຢູໂຣບຕາເວັນອອກ

5

ອາຟຣິກາຕາເວັນອອກ

8

ອາຟຣິກາຕາເວັນຕົກ ແລະ ອາຟຣິກາກາງ

9

ອາຟຣິກາຕອນໃຕ້

8

ອາເມຣິກາ

5

ໂອຊີອານີ

5