メインコンテンツへスキップ
POST
テキストでドキュメントを更新

承認

Authorization
string
header
必須

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401unauthorized)で失敗します。

パスパラメータ

dataset_id
string<uuid>
必須

ナレッジベース ID です。ナレッジベースリストを取得 から取得します。

document_id
string<uuid>
必須

ドキュメント ID です。ナレッジベースのドキュメントリストを取得 から取得します。

ボディ

application/json
name
string

ドキュメント名です。text を指定する場合は必須です。

text
string

ドキュメントのテキスト内容です。

process_rule
object

チャンキングの処理ルールです。

doc_form
enum<string>
デフォルト:text_model

text_model は標準テキストチャンキング、hierarchical_model は親子チャンク構造、qa_model は質問・回答ペアの抽出です。

利用可能なオプション:
text_model,
hierarchical_model,
qa_model
doc_language
string
デフォルト:English

処理最適化のためのドキュメント言語です。

retrieval_model
object

このナレッジベースをクエリする際のチャンクの検索方法とランキング方法を制御します。

レスポンス

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

document
object
batch
string

インデックス進捗を追跡するためのバッチ ID です。