メインコンテンツへスキップ
POST
/
datasets
/
{dataset_id}
/
documents
/
{document_id}
/
update-by-text
テキストでドキュメントを更新
curl --request POST \
  --url http://{apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/update-by-text \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "text": "<string>",
  "process_rule": {
    "mode": "automatic",
    "rules": {
      "pre_processing_rules": [
        {
          "id": "remove_extra_spaces",
          "enabled": true
        }
      ],
      "segmentation": {
        "separator": "<string>",
        "max_tokens": 123
      },
      "parent_mode": "full-doc",
      "subchunk_segmentation": {
        "separator": "<string>",
        "max_tokens": 123,
        "chunk_overlap": 123
      }
    }
  }
}
'
{
  "document": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "position": 123,
    "data_source_type": "<string>",
    "data_source_info": {},
    "dataset_process_rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "created_from": "<string>",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": 123,
    "tokens": 123,
    "indexing_status": "<string>",
    "error": "<string>",
    "enabled": true,
    "disabled_at": 123,
    "disabled_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "archived": true,
    "display_status": "<string>",
    "word_count": 123,
    "hit_count": 123,
    "doc_form": "<string>"
  },
  "batch": "<string>"
}

Authorizations

​
Authorization
string
header
required

APIキー認証。すべてのAPIリクエストにおいて、Authorization HTTPヘッダーにAPIキーを含めてください。形式：Bearer {API_KEY}。APIキーの漏洩を防ぐため、APIキーはクライアント側で共有または保存せず、サーバー側で保存することを強くお勧めします。

Path Parameters

​
dataset_id
string<uuid>
required

ドキュメントを含むナレッジベースのID。

​
document_id
string<uuid>
required

更新するドキュメントのID。

Body

application/json
​
name
string

ドキュメントの新しい名前（オプション）。

​
text
string

ドキュメントの新しいテキストコンテンツ（オプション）。

​
process_rule
object

クリーニングとセグメント化を含む、ドキュメントを処理するためのルールセット。

Response

200 - application/json

ドキュメントが正常に更新されました。

​
document
object
​
batch
string

インデックス化の進捗を追跡するためのバッチ識別子。