テキストドキュメントのアップデート

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

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

リクエストメソッド

PUT

リクエストURL

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

リクエスト認証

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

リクエスト

リクエスト例

curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/text/update' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "knowledge_base_id": "67457fea6f658672d6482542", "chunk_token": 600, "splitter": "\n", "files": [ { "doc_id": "675158a5af12af632a4f63f6", "file_url": "https://www.gptbots.ai/doc/article_1.pdf", "source_url": "https://www.gptbots.ai/doc/article_1.pdf", "file_name": "article_1.pdf" } ] }'

                      
                      curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/text/update' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "knowledge_base_id": "67457fea6f658672d6482542",
    "chunk_token": 600,
    "splitter": "\n",
    "files": [
        {
            "doc_id": "675158a5af12af632a4f63f6",
            "file_url": "https://www.gptbots.ai/doc/article_1.pdf",
            "source_url": "https://www.gptbots.ai/doc/article_1.pdf",
            "file_name": "article_1.pdf"
        }
    ]
}'

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

リクエストヘッダー

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

リクエストボディ

フィールド	タイプ	必須	説明
files	Array	必須	更新対象のドキュメントリストです。最大200件まで同時に更新できます。
doc_id	String	必須	アップデート対象のドキュメントIDです。
file_url	String	任意	アップデート対象のドキュメントURLです。対応形式：pdf / txt / md / doc / docx PDFは最大30MB、その他は最大10MB。file_urlまたはfile_base64のいずれかが必須で、両方指定された場合はfile_base64が優先されます。
file_base64	String	任意	アップデート対象ドキュメントのBase64エンコード文字列です。対応形式：pdf / txt / md / doc / docx PDFは最大30MB、その他は最大10MB。file_urlまたはfile_base64のいずれかが必須で、両方指定された場合はfile_base64が優先されます。
source_url	String	任意	アップデート対象のドキュメントのリソースURLです。URLフォーマットの仕様に準拠する必要があります。空の場合はこの値は更新されません。値を空にしたい場合は `NULL` を入力してください。
chunk_token	Integer	任意	チャンク分割時の1チャンクあたりの最大トークン数。デフォルトは600。範囲：1-1000。chunk_tokenまたはsplitterのいずれかの指定が必要で、両方指定された場合はsplitterが優先されます。
splitter	String	任意	チャンク分割に使用する区切り文字です。デフォルトは空です。改行で分割する場合は `\n` を指定します。chunk_tokenまたはsplitterのいずれかの指定が必要で、両方指定された場合はsplitterが優先されます。

レスポンス

レスポンス例

{ "doc": [ { "doc_id": "xxxxxx", "doc_name": "test_1.txt" }, { "doc_id": "xxxxxx", "doc_name": "test_2.pdf" } ], "failed": [ "xxxxxx", "xxxxxx" ] }

                      
                      {
    "doc": [
        {
            "doc_id": "xxxxxx",
            "doc_name": "test_1.txt"
        },
        {
            "doc_id": "xxxxxx",
            "doc_name": "test_2.pdf"
        }
    ],
    "failed": [
        "xxxxxx",
        "xxxxxx"
    ]
}

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

成功時のレスポンス

フィールド	タイプ	説明
doc	Array	更新対象ドキュメントの一覧です。
doc_id	String	更新対象ドキュメントのIDです。
doc_name	String	更新対象ドキュメントの名前です。
failed	Array	更新に失敗したドキュメントIDの一覧です。

エラー時のレスポンス

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