ファイルからドキュメントを作成

ファイルをアップロードして既存のナレッジベース内に新しいドキュメントを作成します。

POST /datasets/{dataset_id}/document/create-by-file

Error

A valid request URL is required to generate request examples

200

{
  "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>"
}

承認

Authorization · string · header · 必須

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

パスパラメータ

dataset_id · string<uuid> · 必須

ドキュメントを追加するナレッジベースのID。

ボディ

multipart/form-data

data · string

ドキュメントメタデータと処理ルールを含むJSON文字列。詳細はCreateDocumentByFileRequestDataスキーマを参照してください。

例:

"{\"indexing_technique\":\"high_quality\",\"process_rule\":{\"mode\":\"custom\", \"rules\": { \"segmentation\":{\"separator\":\"###\", \"max_tokens\":500}}},\"summary_index_setting\":{\"enable\":true,\"model_name\":\"qwen-vl-plus\",\"model_provider_name\":\"langgenius/tongyi/tongyi\",\"summary_prompt\":\"summarize the text\"}}"

file · file

アップロードするファイル。

レスポンス

200

application/json

ドキュメントが正常に作成され、インデックス化されています。

document · object

表示 子属性

batch · string

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