エラー有無はResponseのstatus codeで判断でき、詳細はレスポンスボディのerrorで確認できるようにする。errorの詳細は以下。
| パラメータ名 | 型 | 説明 |
|---|---|---|
| error | object | |
| error.code | string | エラーコード |
| error.message | string | エラーの詳細メッセージ |
{
"error":
{
"code": "0xXXXXXXXX",
"message": "userContent is a requrired parameter"
}
]
}
一般的なHTTP Status Codeを返却(異常系は400、500)。
エラーコードはどの処理でエラーが起こったのかを判別できるようにする。詳細はエラーメッセージを確認。
| エラーコード | 説明 |
|---|---|
| 02000001 | リクエストのHTTPヘッダー情報が不正 |
| 02000002 | リクエストパラメータが不正 |
| 02000003 | データベースエラー |
| 02000004 | LLM関連エラー |
| 02000005 | 検索関連エラー |
| 02000006 | 認証関連エラー |
| 02000007 | 内部エラー |
| 02000008 | 管理APIエラー |
| 02000009 | 拡張対話API(ファイル読み込み)エラー |
| 02000010 | 拡張対話API(URL読み込み)エラー |
| 02000011 | 拡張対話API(Web検索)エラー |
alignmentの場合は以下。
| エラーコード | 説明 |
|---|---|
| 02000001 | リクエストのHTTPヘッダー情報が不正 |
| 02000002 | リクエストパラメータが不正 |
| 02000003 | 認証関連エラー |
| 02000004 | 判定機能関連エラー |
| 02000005 | RAGオプション関連エラー |
| 02000006 | 内部エラー |
| エラーメッセージ | 説明 |
|---|---|
| Internal error is occurred. | 内部エラーが発生 |
| XXX is a required parameter. | 必須パラメータの指定がない。XXXにはパラメータ名が記載 |
| XXX and YYY parameters cannot be specified at the same time. | 2つのパラメータが同時に指定された。XXXとYYYにはパラメータ名が記載 |
| Either XXX or YYY is a required parameter. | 2つのパラメータのどちらかが必須。XXXとYYYにはパラメータ名が記載 |
| XXX is a required header. | 必須ヘッダーの指定がない。XXXにはパラメータ名が記載 |
| database internal error. | データベースの不正操作 |
| database operation is failed. | データベース操作中にエラーが発生 |
| llm prompt is invalid. | LLMへの入力プロンプトが不正 |
| llm operation error (Detail:XXX). | LLM処理中にエラー発生。Detailに具体的なエラー内容が記載されているので詳細はそちらを参照 |
| document search error. | 検索処理中にエラー発生 |
| XXX is a invalid parameter. | リクエストパラメータの値が不正。XXXにはパラメータ名が記載 |
| XXX is not found. | 必要なデータベース情報が見つからない(historyIdなど) |
| XXX(YYY) is not found. | 入力パラメータが存在しない |
| invalid authentication api response. | 認証情報取得処理に失敗 |
| error occurs in authentication api process. | 認証情報取得処理中にエラー発生 |
| parameter not specified or not in json format. | 入力パラメータが未指定か、Jsonフォーマットに準拠していない |
| invalid tenant information. | テナント情報が不正 |
| error occurs in template api process (Status code:XXX). | テンプレート情報取得処理に失敗。Status codeにHTTPステータスコードを記載しているので詳細はそちらで確認 |
| error occurs in vectorIndex api process (Status code:XXX). | インデックス情報取得処理に失敗。Status codeにHTTPステータスコードを記載しているので詳細はそちらで確認 |
| error occurs in info api process (Status code:XXX). | 契約情報取得処理に失敗。Status codeにHTTPステータスコードを記載しているので詳細はそちらで確認 |
| error occurs in vector db api process (Status code:XXX). | ベクターDB情報取得処理に失敗。Status codeにHTTPステータスコードを記載しているので詳細はそちらで確認 |
| unsupported file extension. (XXX) | ファイル名不正 |
| failed to load file. | ファイル読み込みに失敗 |
| failed base64 decode. | BASE64デコード処理に失敗 |
| faild parse file. | ファイルの解析処理に失敗 |
| incorrect url value. | URLのドメインが不正 |
| failed to read url. | URLのアクセスエラー |
| functionality restricted in closed network environment. | 閉域環境のための機能制限エラー |
| model conflict error. model:XXX and YYY. | モデル競合エラー |
| model is not specified. | モデル未指定 |
| input is too long. max length is XXX. | 入力が長すぎる |
| input is too many keywords. max length is XXX. | 検索キーワードが多すぎる |
| No web search results found. | Web検索結果が見つからない |
| The scraping result could not be retrieved. | スクレイピング結果が取得できない |
| XXX API search error (Detail:YYY). | 検索エンジンAPIのエラー |
| No search results found. | 検索結果が見つからない |
| Web search is restricted. Please contact your administrator for assistance. | Web検索機能の使用が無効になっている |
| Failed to retrieve Web search API key. (Detail:XXX) | Web検索APIキーの取得に失敗 |
| Web search API key is not set. | Web検索APIキーが設定されていない |
| Web search engine 'XXX' is not supported. | Web検索エンジンがサポートされていない |
| Authentication UI API access error (XXX). | 管理UI用APIアクセスでエラー |
| The specified model 'XXX' does not support image input. | 画像入力に対応していないモデルが指定された |
| Invalid base64 format: XXX | BASE64データの形式が不正 |
| Image data too small. | 画像データが小さすぎる |
| Image validation failed: XXX | 画像検証に失敗 |
| The input exceeds the maximum allowed length. (Detail: XXX) | LLMプロンプトが最大長を超えた |
| File extension (XXX) doesn't match detected format. (YYY) | 画像のファイル拡張子と実際の形式が一致しない |