ការផ្ទៀងផ្ទាត់ដោយប្រើ API key

CLEVI Gateway ផ្ទៀងផ្ទាត់ផ្លូវដែលឆបគ្នាជាមួយ OpenAI និងផ្លូវដែលឆបគ្នាជាមួយ Anthropic ដោយប្រើ API key តែមួយ។
តម្លៃដែលត្រូវកំណត់នៅម៉ាស៊ីនភ្ញៀវមានពីរ គឺបឋមកថាផ្ទៀងផ្ទាត់ដែលផ្ទុក key និង base URL របស់ SDK ហើយទម្រង់បឋមកថា និង base URL ដែលអនុញ្ញាតខុសគ្នាតាមស្តង់ដារនីមួយៗ។
បន្ទាប់ពីបញ្ចប់ការកំណត់ អ្នកអាចពិនិត្យការផ្ទៀងផ្ទាត់បានភ្លាមៗ ដោយទាញយកបញ្ជីម៉ូដែល។
ប្រសិនបើការផ្ទៀងផ្ទាត់បរាជ័យ នឹងត្រឡប់ 401 ហើយប្រសិនបើការផ្ទៀងផ្ទាត់ជោគជ័យ ប៉ុន្តែមិនបំពេញលក្ខខណ្ឌសិទ្ធិ ឬកម្រិតប្រើប្រាស់ នឹងត្រឡប់ 403។

សូមចេញ API key ពីទំព័រ API key ក្នុងកុងសូល។ អ្នកក៏អាចគ្រប់គ្រងការលុបចោល key និងវិសាលភាពនៃការប្រើប្រាស់របស់វាពីទំព័រដដែលបាន។

បឋមកថាផ្ទៀងផ្ទាត់

ស្តង់ដារទាំងពីរដាក់ API key ក្នុងបឋមកថាសំណើមួយ។ ប្រើមួយក្នុងចំណោមបឋមកថា X-API-Key និង Authorization ហើយទម្រង់ដែលអនុញ្ញាតខុសគ្នាតាមស្តង់ដារ។

នៅពេលប្រើបឋមកថា Authorization ក្នុងផ្លូវដែលឆបគ្នាជាមួយ OpenAI ត្រូវមានបុព្វបទ Bearer។ ប្រសិនបើផ្ញើតែ key ដោយគ្មានបុព្វបទនេះ Gateway នឹងបដិសេធសំណើ។

ឈ្មោះបឋមកថាមិនប្រកាន់អក្សរធំតូចទេ ដូច្នេះបឋមកថា x-api-key ដែល Anthropic SDK ផ្ញើក៏ដំណើរការដូចដើមដែរ។ ប្រសិនបើកំណត់បឋមកថាទាំងពីរ តម្លៃ X-API-Key នឹងត្រូវបានអនុវត្តជាអាទិភាព។

base URL

SDK ដែលអ្នកបានប្រើពីមុនអាចប្រើបានដដែល ដោយគ្រាន់តែប្តូរ base URL ទៅអាសយដ្ឋានខាងក្រោម។ អាសយដ្ឋានទាំងពីរខុសគ្នាត្រង់ថាតើរួមបញ្ចូល /v1 ឬអត់ ដូច្នេះសូមកំណត់អាសយដ្ឋានឱ្យដូចដែលបានបង្ហាញ ស្របតាមស្តង់ដារ។

ពិនិត្យការផ្ទៀងផ្ទាត់

បន្ទាប់ពីកំណត់ API key និង base URL រួច សូមទាញយកបញ្ជីម៉ូដែល ដើម្បីពិនិត្យមើលថាតើការផ្ទៀងផ្ទាត់បានជោគជ័យឬអត់។ ឧទាហរណ៍ខាងក្រោមបង្ហាញពីការដំណើរការការទាញយកដូចគ្នា ដោយប្រើ curl, OpenAI SDK និង Anthropic SDK។ នៅកន្លែង sk-... សូមបញ្ចូល key ដែលបានចេញពីទំព័រ API key។

នៅពេលទាញយកដោយប្រើ curl សូមបញ្ជាក់ផ្លូវពេញលេញរហូតដល់ /v1/models សម្រាប់ទម្រង់ទាំងពីរ។ ពាក្យបញ្ជាទីមួយប្រើបឋមកថា X-API-Key សម្រាប់ផ្លូវដែលឆបគ្នាជាមួយ OpenAI ហើយពាក្យបញ្ជាទីពីរប្រើបឋមកថា Authorization សម្រាប់ផ្លូវដែលឆបគ្នាជាមួយ 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"

សម្រាប់ OpenAI SDK សូមបញ្ជាក់អាសយដ្ឋានដែលរួមមាន /v1 នៅក្នុង 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)

សម្រាប់ Anthropic SDK សូមបញ្ជាក់ base_url ជាអាសយដ្ឋានដែលបញ្ចប់នៅមុខ /v1។
សម្រាប់ការផ្ទៀងផ្ទាត់ សូមប្រើបឋមកថា x-api-key ដែល 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)

ប្រសិនបើការឆ្លើយតបពីឧទាហរណ៍ណាមួយមានលេខ 200 នោះមានន័យថាការផ្ទៀងផ្ទាត់បានជោគជ័យ ហើយ data ក្នុងការឆ្លើយតបមានបញ្ជីម៉ូដែលដែលអាចហៅបានដោយប្រើ key នេះ។ ប្រសិនបើទទួលបាន 401 សូមពិនិត្យមូលហេតុតាមលំដាប់ក្នុងផ្នែកបន្ទាប់។

ការផ្ទៀងផ្ទាត់បានបរាជ័យ

ប្រសិនបើផ្ញើដោយគ្មាន key ឬប្រើ key ដែលផុតកំណត់ ឬត្រូវបានលុបចោល នឹងត្រឡប់ 401។ នៅលើផ្លូវដែលឆបគ្នាជាមួយ OpenAI ប្រសិនបើហៅដោយគ្មាន key នឹងត្រឡប់តួអត្ថបទខាងក្រោម ហើយនៅលើផ្លូវដែលឆបគ្នាជាមួយ Anthropic, error.type គឺ authentication_error។

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

ប្រសិនបើទទួលបាន 401 សូមពិនិត្យតាមលំដាប់ដូចខាងក្រោម។

1. សូមពិនិត្យស្ថានភាព key នៅទំព័រ API key។ ប្រសិនបើ key ផុតកំណត់ ឬត្រូវបានលុបចោល សូមចេញ key ថ្មី។
2. សូមពិនិត្យថាឈ្មោះបឋមកថាជា X-API-Key ឬ Authorization។
3. ប្រសិនបើប្រើបឋមកថា Authorization នៅលើផ្លូវដែលឆបគ្នាជាមួយ OpenAI សូមពិនិត្យថាមានបុព្វបទ Bearer ឬអត់។

បន្ទាប់ពីកែតម្រូវរួច សូមដំណើរការការទាញយកបញ្ជីម៉ូដែលឡើងវិញនៅក្នុងផ្នែកពិនិត្យការផ្ទៀងផ្ទាត់ ដើម្បីបញ្ជាក់ថាទទួលបាន 200។

បឋមកថាដែលប្រើរួមគ្នា

បឋមកថាខាងក្រោមទាំងអស់ជាជម្រើស។ យើងណែនាំឱ្យកំណត់ X-Request-Id ដើម្បីអាចតាមដានបញ្ហាបាន។

ប្រសិនបើ 5xx កើតឡើងម្តងហើយម្តងទៀត សូមជូនដំណឹងតាមជំនួយ និងការទាក់ទង ដោយភ្ជាប់ X-Request-Id មកជាមួយ។ ប្រសិនបើជាតម្លៃដែលបានកំណត់ដោយផ្ទាល់ អ្នកអាចផ្ទៀងផ្ទាត់ជាមួយកំណត់ត្រារបស់ម៉ាស៊ីនភ្ញៀវបានភ្លាមៗ។