Skip to main content
POST
ファイルからドキュメントを作成

承認

Authorization
string
header
必須

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

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

パスパラメータ

dataset_id
string<uuid>
必須

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

ボディ

multipart/form-data
file
file
必須

アップロードするファイルです。デフォルトの上限は 15 MB です。

UPLOAD_FILE_SIZE_LIMIT 環境変数 で調整できます。

data
string

設定情報を含む JSON 文字列です。テキストからドキュメントを作成 と同じフィールド(indexing_technique、doc_form、doc_language、process_rule、retrieval_model、embedding_model、embedding_model_provider)を受け付けますが、name と text は除きます。

例:

"{\"indexing_technique\":\"high_quality\",\"doc_form\":\"text_model\",\"doc_language\":\"English\",\"process_rule\":{\"mode\":\"automatic\"}}"

レスポンス

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

document
object
batch
string

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