チャンクの追加（Text）.md

テキストドキュメントにナレッジブロック（チャンク）を追加します。システムは順に以下の処理を実行します：チャンク化（スライス）、埋め込み（ベクトル化）、そして最終的に新しいナレッジブロックをドキュメントに追加します。

注:使用される埋め込みモデルはデフォルトモデルであり、API内で指定することはできません。

リクエストメソッド

POST

リクエストURL

https://api-${endpoint}.gptbots.ai/v1/bot/doc/chunks/add

リクエスト認証

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

リクエスト

リクエスト例

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/chunks/add' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "doc_id": "675174292b8b977ba6316191", "chunks": [ { "content": "This is a chunk.", "keywords": ["This","chunk"] } ] }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/chunks/add' \
-H 'Authorization: Bearer ${API Key}' \	
-H 'Content-Type: application/json' \
-d '{
    "doc_id": "675174292b8b977ba6316191",
    "chunks": [
        {
            "content": "This is a chunk.",
            "keywords": ["This","chunk"]
        }
    ]
}'

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

リクエストヘッダー

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

リクエストボディ

フィールド	タイプ	必須	説明
doc_id	String	必須	ナレッジブロックを追加する対象ドキュメントの ID を指定してください。
チャンク	Array<Object>	必須	ナレッジブロックの内容を入力してください。
内容	String	必須	ナレッジブロックの内容を入力してください（最大 1000 トークン）
キーワード	Array<Object>	任意	ナレッジブロックに関連するキーワードを入力してください。

レスポンス

レスポンス例

{ "code": 0, "message": "OK" }

                      
                      {
    "code": 0,
    "message": "OK"
}

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

成功時のレスポンス

フィールド	タイプ	説明
code	Int	レスポンスコード
message	String	レスポンスの詳細内容

エラー時のレスポンス

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