スプレッドシートドキュメントの追加（file）.md
スプレッドシートドキュメントの追加（file）.md
表形式のファイルを一括アップロードし、順にチャンク化／分割、埋め込み／ベクトル化、保存を実行します。
注:
embedding_model_version_idで埋め込みモデルを指定できます。省略した場合はシステムのデフォルト埋め込みモデルが使用されます。
注:この操作はアップロード結果のみを返し、最終的な埋め込み結果は返しません。最終結果を取得するには「ドキュメントステータスのクエリ（Query Document Status）」APIを使用してください。
リクエストメソッド
POST
リクエストURL
https://api-${endpoint}.gptbots.ai/v1/bot/doc/spreadsheet/add
リクエスト認証
認証方法の説明についてはAPI Overviewをご参照ください。
リクエスト
リクエスト例
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/spreadsheet/add' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"knowledge_base_id": "67457fea6f658672d6482542",
"embedding_model_version_id": "6620f06262390a0be1411c5d",
"chunk_token": 700,
"header_row": 5,
"files": [
{
"file_url": "https://www.gptbots.ai/doc/spreadsheet_1.xlsx",
"file_base64": "SGVsbG8sIEJhc2U2NCBFbmNvZGluZyE=",
"source_url": "https://www.gptbots.ai/doc/spreadsheet_1.xlsx",
"file_name": "spreadsheet_1.xlsx"
}
]
}'
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/spreadsheet/add' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"knowledge_base_id": "67457fea6f658672d6482542",
"embedding_model_version_id": "6620f06262390a0be1411c5d",
"chunk_token": 700,
"header_row": 5,
"files": [
{
"file_url": "https://www.gptbots.ai/doc/spreadsheet_1.xlsx",
"file_base64": "SGVsbG8sIEJhc2U2NCBFbmNvZGluZyE=",
"source_url": "https://www.gptbots.ai/doc/spreadsheet_1.xlsx",
"file_name": "spreadsheet_1.xlsx"
}
]
}'
このコードブロックをポップアップで表示
リクエストヘッダー
| フィールド | タイプ | 説明 |
|---|---|---|
| Authorization | Bearer ${API Key} | 認証には Authorization: Bearer ${API Key} を使用してください。トークンはAPIキーページから取得できます。 |
| Content-Type | application/json | データの形式は application/json を設定してください。 |
リクエストボディ
| フィールド名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| knowledge_base_id | String | 任意 | ドキュメントを追加する対象のナレッジベースのID。未指定の場合は「Default」ナレッジベースが使用されます。 |
| files | Array<Object> | 必須 | 追加するドキュメントの一覧。一度に最大20件まで追加が可能です。 |
| file_url | String | 任意 | 追加するドキュメントのURL。対応フォーマット：csv / xls / xlsx。1ファイルあたり最大サイズは10MB。※URLまたはbase64のいずれかを指定してください。両方指定された場合はbase64が優先されます。 |
| file_base64 | String | 任意 | 追加するドキュメントのBase64形式。対応フォーマット：csv / xls / xlsx。1ファイルあたり最大サイズは10MB。※URLまたはbase64のいずれかを指定してください。両方指定された場合はbase64が優先されます。 |
| file_name | String | 必須 | 追加するドキュメントの名前（1〜200文字以内）。 |
| source_url | String | 任意 | 追加するドキュメントの元となるURL。URL形式に準拠している必要があります。 |
| embedding_model_version_id | String | 任意 | このバッチのドキュメントをベクトル化する埋め込みモデルのバージョンID。省略した場合はシステムのデフォルト埋め込みモデルが使用されます。値はモデル一覧の取得 API が返す EMBEDDING グループ内の modelId を指定してください。 |
| chunk_token | Integer | 任意 | チャンク分割時に1つのナレッジチャンクに含める最大トークン数です。初期値は600で、1〜1000の範囲で指定できます。 |
| header_row | Integer | 任意 | ヘッダー行として認識される最大行数を指定します。テーブル形式のドキュメントは「ヘッダー＋データ行」の構成でチャンクに分割されます。初期値は1で、1〜5の範囲で設定可能です。 |
レスポンス
レスポンス例
{
"doc": [
{
"doc_id": "xxxxxx",
"doc_name": "test_1.csv"
},
{
"doc_id": "xxxxxx",
"doc_name": "test_2.xlsx"
}
],
"failed": [
"file_1",
"file_2"
]
}
{
"doc": [
{
"doc_id": "xxxxxx",
"doc_name": "test_1.csv"
},
{
"doc_id": "xxxxxx",
"doc_name": "test_2.xlsx"
}
],
"failed": [
"file_1",
"file_2"
]
}
このコードブロックをポップアップで表示
成功時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| doc | Array<Object> | 追加されたドキュメントの一覧です。 |
| doc_id | String | 追加されたドキュメントのIDです。 |
| doc_name | String | 追加されたドキュメントの名称です。 |
| failed | Array<Object> | 追加に失敗したドキュメント名の一覧です。 |
エラー時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| code | Int | エラーコード |
| message | String | エラーの詳細内容 |
エラーコード
| Code | Message |
|---|---|
| 40000 | パラメータエラー |
| 40000 | The embedding_model_version_id does not exist: 指定したモデルバージョンIDがプラットフォームのモデル一覧に存在しません |
| 40000 | The embedding_model_version_id is not an embedding model: 指定したモデルが埋め込みモデルではありません（例：チャットモデルの modelId を指定した場合） |
| 40000 | The embedding_model_version_id is not an available embedding model: この埋め込みモデルの提供元は API での指定にまだ対応していません |
| 40127 | 開発者認証に失敗しました |
| 20059 | エージェントが削除されています |
注：
embedding_model_version_idの検証に失敗した場合、バッチ内のドキュメントは一切作成されず、failedリストにも含まれません。上記のエラーレスポンスがそのまま返されます。