メインコンテンツへスキップ
POST
テキストからドキュメントを作成

承認

Authorization
string
header
必須

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

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

パスパラメータ

dataset_id
string<uuid>
必須

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

ボディ

application/json
name
string
必須

ドキュメント名です。

text
string
必須

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

indexing_technique
enum<string>

ナレッジベースに最初のドキュメントを追加する際に必須です。以降のドキュメントでは省略するとナレッジベースのインデックス方式を継承します。high_quality は埋め込みモデルによる精密検索、economy はキーワードベースのインデックスを使用します。

利用可能なオプション:
high_quality,
economy
doc_form
enum<string>
デフォルト:text_model

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

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

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

process_rule
object

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

retrieval_model
object

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

embedding_model
string

埋め込みモデル名です。利用可能なモデルを取得model_type=text-embedding を指定した際の model フィールドの値を使用します。

embedding_model_provider
string

埋め込みモデルプロバイダーです。利用可能なモデルを取得model_type=text-embedding を指定した際の provider フィールドの値を使用します。

original_document_id
string

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

レスポンス

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

document
object
batch
string

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