ទិដ្ឋភាពទូទៅ

Endpoint

រាល់ endpoint ស្ថិតក្រោម base URL មួយ ហើយត្រូវបានបម្រើតាម HTTPS។

https://api.shannon-ai.com

endpoint ទាំងបីដែលបង្កើតអត្ថបទទៅដល់ម៉ូដែលដូចគ្នា។ សូមជ្រើសរើសមួយដែលទ្រង់ទ្រាយរបស់វាកូដរបស់អ្នកប្រើរួចហើយ។

មូលដ្ឋាននៃ request

• ខ្លឹមសារនៃរាល់ POST គឺជា JSON object មួយ រហូតដល់ 32 MiB។
• field ដែល API មិនស្គាល់មិនបង្កឱ្យមាន error ហើយគ្មានអានុភាពទេ។ request ដែលសរសេរសម្រាប់អ្នកផ្តល់សេវាផ្សេងមិនបរាជ័យដោយសារ field បន្ថែមទេ។
• field ដែលស្គាល់ប៉ុន្តែមានប្រភេទ JSON ខុស ឬ field ចាំបាច់ដែលបាត់ ត្រូវបានឆ្លើយដោយ 422។ ខ្លឹមសារដែលមិនមែនជា JSON ត្រឹមត្រូវត្រូវបានឆ្លើយដោយ 400។
• model គឺជា id មួយនៅលើទំព័រ Models & pricing។ អក្សរធំ និងអក្សរតូចមិនសំខាន់ទេ។

ចម្លើយគឺជា JSON ឬ stream នៃ server-sent event នៅពេល request កំណត់ stream ជា true។ endpoint នីមួយៗឆ្លើយក្នុងទ្រង់ទ្រាយផ្ទាល់ខ្លួន។ រាល់ចម្លើយមាន header x-request-id។

អ្វីដែល request ឆ្លងកាត់

request ត្រូវបានពិនិត្យតាមលំដាប់ថេរ មុនពេលម៉ូដែលដំណើរការ។ ការពិនិត្យដំបូងដែលបរាជ័យនឹងឆ្លើយ ដូច្នេះ 401 មិនទាន់ប្រាប់អ្វីអំពីខ្លឹមសារទេ។

រូបរាងនៃ error

error គឺជា JSON object ដែលមាន error ដែលមាន type និង message។ /v1/messages រុំវាតាមរបៀបដែល Anthropic SDK រំពឹង ចំណែក path ផ្សេងទៀតទាំងអស់ប្រើរូបរាង OpenAI។

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

• សូមអាន type និង message។ code និង param មានលើតែ error ខ្លះប៉ុណ្ណោះ៖ សូមចាត់ទុកថាជាជម្រើស។ param តែងតែជា null។
• បន្ទាប់ពី stream ចាប់ផ្តើម status គឺ 200 រួចហើយ។ ការបរាជ័យពេលនោះមកដល់ជា error frame នៅក្នុង stream។
• រាល់ចម្លើយ error មាន header x-request-id។

ការគ្រប់គ្រងកំហុស

ការទូទាត់ និងសមតុល្យ

• មានសមតុល្យមួយក្នុងមួយគណនី ហើយ chat និង API ប្រើរួមគ្នា៖ កូតាគម្រោងប្រចាំថ្ងៃជាមុនសិន បន្ទាប់មកឥណទានដែលបានទិញ។ API គ្មានកូតាផ្ទាល់ខ្លួនទេ។
• request បម្រុង output budget របស់វា (max_tokens លំនាំដើម 4,096) ហើយបន្ទាប់មកត្រូវបានគិតថ្លៃសម្រាប់ token ដែលវាប្រើពិតប្រាកដ តាមតម្លៃរបស់ម៉ូដែល។
• រាល់ចម្លើយរាយការណ៍ចំនួន token របស់វាក្នុង usage។ ទំព័រ Keys & usage បង្ហាញសមតុល្យ និងតម្លៃនៃ request នីមួយៗ។
• រាល់ request ត្រូវបានបម្រើស្មើគ្នា។ ដែនកំណត់តែមួយគត់លើអត្រា request គឺ flood protection៖ 120 request ក្នុងមួយនាទីក្នុងមួយគណនី។ request ដែលផ្ញើស្របគ្នារង់ចាំជាជួរ។

ដែនកំណត់ និងសមតុល្យ ម៉ូដែល និងតម្លៃ Keys & usage

Field ដែលអាស្រ័យលើម៉ូដែល

គ្រប់ម៉ូដែលទទួល request ដូចគ្នា។ field ខ្លះមានអានុភាពលើតែម៉ូដែលខ្លះប៉ុណ្ណោះ៖ តារាងបញ្ជាក់កន្លែងដែលវាមាន។ ទំព័រ endpoint រាយគ្រប់ field។

Chat Completions

មកពី OpenAI SDK

• កំណត់ base URL ជា https://api.shannon-ai.com/v1 ហើយកំណត់ key ជា Shannon key របស់អ្នក។ ការហៅ Chat Completions និង Responses នឹងដំណើរការជាមួយ SDK ដូចដែលវាជា។
• model ត្រូវតែជា Shannon id។ ឈ្មោះម៉ូដែលរបស់អ្នកផ្តល់សេវាផ្សេងដូចជា gpt-4o ត្រូវបានឆ្លើយដោយ 400 និង unknown model។
• Reasoning មកក្នុង field ផ្ទាល់ខ្លួន៖ reasoning_content ក្បែរ content ក្នុងសារ និងក្នុង stream delta។
• stream តែងតែមាន usage ក្នុង chunk ចុងក្រោយ រួមជាមួយ finish_reason។
• ការហៅ tool ក្នុង stream មកដល់ជា chunk មួយដែលមាន string arguments ពេញលេញ។
• ចម្លើយមានជម្រើសមួយ។
• path របស់ OpenAI API ដែលមិនមានក្នុងតារាងខាងលើ ដូចជា /v1/embeddings ត្រូវបានឆ្លើយដោយ 404។

មកពី Anthropic SDK

• កំណត់ base URL ជា https://api.shannon-ai.com ដោយគ្មាន /v1 ហើយកំណត់ key ជា Shannon key របស់អ្នក។ SDK ផ្ញើវាជា x-api-key។
• model ត្រូវតែជា Shannon id។
• max_tokens ជាជម្រើសលើ API នេះ។ លំនាំដើមរបស់វាគឺ 4,096។
• ចម្លើយមាន content block ប្រភេទ thinking, text និង tool_use។ block ដំបូងមិនមែនជាអត្ថបទជានិច្ចទេ៖ សូមជ្រើស block តាម type។
• stop_reason គឺ end_turn ឬ tool_use។ stream របស់ម៉ូដែល Shannon ក៏អាចបញ្ចប់ដោយ max_tokens ដែរ។
• anthropic-version និង anthropic-beta ត្រូវបានទទួលយក ដូច្នេះ SDK ដំណើរការដដែល។ request មិនចាំបាច់មានពួកវាទេ។
• កំហុសលើ /v1/messages មានរូបរាង Anthropic៖ {"type": "error", "error": {…}}។

ឧបករណ៍សរសេរកូដដែលនិយាយទ្រង់ទ្រាយទាំងនេះត្រូវបានរៀបចំតាមរបៀបដូចគ្នា៖ base URL, key និង Shannon id ជាម៉ូដែល។ ឧបករណ៍សរសេរកូដ CLI