ステータスコード
AI Search Open Platform に対して API または SDK 呼び出しを実行すると、ステータスコードが返されます。 このコードは、呼び出しの結果を示します。 code パラメーターと status パラメーターに基づいて、呼び出し結果の詳細を見つけることができます。
次の表は、AI Search Open Platform の一般的なステータスコードを示しています。
カテゴリ | HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
リクエストエラー | 400 | InvalidParameter | 必須パラメーターが見つからないか無効です。リクエストパラメーターを確認してください。 | 1 つ以上のリクエストパラメーターが無効です。 |
400 | ServiceIdNotExist | service_id が存在しません。 | サービス ID が存在しません。 | |
429 | Throttling | リクエストの速度制限がトリガーされました。 | API 呼び出しによって速度制限がトリガーされます。 | |
429 | Throttling.RateQuota | リクエストレート制限を超えました。後でもう一度お試しください。 | 1 秒あたりのリクエスト数など、呼び出しの頻度によって速度制限がトリガーされます。 | |
429 | Throttling.AllocationQuota | 割り当てられたクォータを超えました。クォータ制限を増やしてください。 | 1 分あたりに生成されるトークン数など、特定の期間内の呼び出し回数によって速度制限がトリガーされます。 | |
429 | Throttling.AllocationQuota | 無料の割り当てクォータを超えました。 | 無料のクォータが使い果たされ、モデルの課金対象アクセスが有効になっていません。 | |
サーバーエラー | 500 | InternalServerError | 内部エラーが発生しました。後でもう一度お試しいただくか、サービスサポートに連絡してください。 | 内部エラーが発生しました。 |
サンプルレスポンス
AI Search Open Platform の呼び出しが失敗した場合、エラーの詳細を含むメッセージが HTTP ステータスコードと共に返されます。 サンプルレスポンス:
{
"request_id": "817964CD-1B84-4AE1-9B63-4FB99734DD41",
"latency": 0,
"code": "InvalidParameter",
"message": "JSON parse error: Invalid UTF-8 start byte 0xbc; nested exception is com.fasterxml.jackson.core.JsonParseException: Invalid UTF-8 start byte 0xbc\n at line: 2, column: 19]"
}
レスポンスパラメーター
パラメーター | タイプ | 説明 |
HTTP ステータスコード | integer | ステータスコード 200 は、リクエストが成功したことを示します。 他のステータスコードは、リクエストが失敗したことを示します。 リクエストが失敗した場合、対応するエラーコードとエラーメッセージが code パラメーターと message パラメーターに返されます。 |
request_id | string | リクエスト ID。 リクエストの失敗をトラブルシューティングするには、request_id パラメーターの値に基づいてリクエストを見つけることができます。 |
code | string | 失敗した場合に返されるエラーコード。 詳細については、前の表の「エラーコード」列を参照してください。 |
message | string | 失敗した場合に返されるメッセージ。 詳細については、前の表の「エラーメッセージ」列を参照してください。 メッセージは実際のシナリオによって異なる場合があり、前の表とは異なるより具体的な情報が含まれている場合があることに注意してください。 |