スプレッドシートドキュメントの更新（file）

ファイルを使ってドキュメントを一括更新します。
システムは順にチャンク化（分割）、埋め込み（ベクトル化）を行い、元のドキュメントIDを保持したまま、既存の内容を新しいドキュメント内容に置き換えます。

注:使用される埋め込みモデルはデフォルトモデルであり、API内で変更することはできません。
注:このAPIは更新結果のみを返し、最終的な埋め込み結果は返しません。最終的な処理結果は「ドキュメントステータスのクエリ（Query Document Status）」APIを使用して取得してください。

リクエストメソッド

PUT

リクエストURL

https://api-${endpoint}.gptbots.ai/v1/bot/doc/spreadsheet/update

リクエスト認証

認証方法の説明についてはAPI Overviewをご参照ください。

リクエスト

リクエスト例

curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/spreadsheet/update' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "knowledge_base_id": "67457fea6f658672d6482542", "chunk_token": 700, "header_row": 5, "files": [ { "file_url": "https://www.gptbots.ai/doc/spreadsheet.xlsx", "source_url": "https://www.gptbots.ai/doc/spreadsheet.xlsx", "file_name": "spreadsheet_1.xlsx" } ] }'

                      
                      curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/spreadsheet/update' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "knowledge_base_id": "67457fea6f658672d6482542",
    "chunk_token": 700,
    "header_row": 5,
    "files": [
        {
            "file_url": "https://www.gptbots.ai/doc/spreadsheet.xlsx",
            "source_url": "https://www.gptbots.ai/doc/spreadsheet.xlsx",
            "file_name": "spreadsheet_1.xlsx"
        }
    ]
}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Bearer ${API Key}	認証には `Authorization: Bearer ${API Key}` を使用してください。トークンはAPIキーページから取得できます。
Content-Type	application/json	データの形式は `application/json`を設定してください。

リクエストボディー

フィールド	タイプ	必須	説明
files	Array<Object>	必須	更新対象のドキュメント一覧です。一度に最大20件まで指定できます。
doc_id	String	必須	更新対象のドキュメントIDです。
file_url	String	任意	更新するドキュメントのURLです。対応形式:csv / xls / xlsx 1ファイルあたり最大10MB。注:file_url か file_base64 のいずれかが必須で、両方指定された場合は file_base64 が優先されます。
file_base64	String	任意	更新するドキュメントのBase64文字列です。対応形式:csv / xls / xlsx 1ファイルあたり最大10MB。file_url か file_base64 のいずれかが必須で、両方指定された場合は file_base64 が優先されます。
source_url	String	任意	更新予定の文書のリソースURLです。URLフォーマットの仕様に準拠する必要があります。空の場合、システムはこの値を更新しません。この値を空にしたい場合は `NULL` を入力してください。
chunk_token	Integer	任意	チャンク分割時における、1チャンクあたりの最大トークン数です。初期値は600で、設定可能な範囲は1〜1000です。注:chunk_token または splitter のいずれかを必ず指定してください。両方が指定された場合は、splitter が優先されます。
header_row	Integer	任意	ヘッダー行として認識される最大行数です。表形式のドキュメントは「ヘッダー行 + データ行」の構成でチャンク化されます。初期値は1で、1〜5の範囲で設定できます。

レスポンス

レスポンス例

{ "doc": [ { "doc_id": "xxxxxx", "doc_name": "test_1.csv" }, { "doc_id": "xxxxxx", "doc_name": "test_2.xlsx" } ], "failed": [ "xxxxxx", "xxxxxx" ] }

                      
                      {
    "doc": [
        {
            "doc_id": "xxxxxx",
            "doc_name": "test_1.csv"
        },
        {
            "doc_id": "xxxxxx",
            "doc_name": "test_2.xlsx"
        }
    ],
    "failed": [
        "xxxxxx",
        "xxxxxx"
    ]
}

このコードブロックをポップアップで表示

成功時のレスポンス

フィールド	タイプ	説明
doc	Array<Object>	更新に成功したドキュメントの一覧です。
doc_id	String	更新対象となったドキュメントのIDです。
doc_name	String	更新対象となったドキュメントのファイル名です。
failed	Array<Object>	更新に失敗したドキュメントIDの一覧です。

エラー時のレスポンス

フィールド	タイプ	説明
code	Int	エラーコード
message	String	エラーの詳細内容