Skip to main content
post/datasets/{dataset_id}/document/create-by-text
Request example
Response
post/datasets/{dataset_id}/document/create-by-text

Authorization

Authorizationstringheaderrequired#

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

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

Path parameters

dataset_idstringrequired#
ナレッジベース ID。ナレッジベースリストを取得 で取得します。スコープを限定したキーでは、Dify の URL から ID をコピー してください。

Body

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

Default: "text_model"

Options:text_modelhierarchical_modelqa_model
doc_languagestring#
処理最適化のためのドキュメント言語です。

Default: "English"

embedding_modelstring#
埋め込みモデル名です。利用可能なモデルを取得 で model_type=text-embedding を指定した際の model フィールドの値を使用します。
embedding_model_providerstring#
埋め込みモデルプロバイダーです。利用可能なモデルを取得 で model_type=text-embedding を指定した際の provider フィールドの値を使用します。
indexing_techniqueenum<string>#
ナレッジベースに最初のドキュメントを追加する際に必須です。以降のドキュメントでは省略するとナレッジベースのインデックス方式を継承します。high_quality は埋め込みモデルによる精密検索、economy はキーワードベースのインデックスを使用します。
Options:high_qualityeconomy
namestringrequired#
ドキュメント名です。
original_document_idstring#
バージョン管理用の元ドキュメント ID です。ナレッジベースのドキュメントリストを取得 から取得します。
process_ruleobject#
チャンキングの処理ルールです。
retrieval_modelobject#
textstringrequired#
ドキュメントのテキスト内容です。

Responses

application/json
ドキュメントが正常に作成されました。
batchstring#
インデックス進捗を追跡するためのバッチ ID です。
documentobject#