メインコンテンツへスキップ
POST
/
datasets
/
{dataset_id}
/
document
/
create-by-text
Error
A valid request URL is required to generate request examples
{
  "document": {
    "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
    "position": 1,
    "data_source_type": "upload_file",
    "data_source_info": {
      "upload_file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "data_source_detail_dict": {
      "upload_file": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "guide.txt",
        "size": 2048,
        "extension": "txt",
        "mime_type": "text/plain",
        "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
        "created_at": 1741267200
      }
    },
    "dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
    "name": "guide.txt",
    "created_from": "api",
    "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
    "created_at": 1741267200,
    "tokens": 0,
    "indexing_status": "indexing",
    "error": null,
    "enabled": true,
    "disabled_at": null,
    "disabled_by": null,
    "archived": false,
    "display_status": "indexing",
    "word_count": 0,
    "hit_count": 0,
    "doc_form": "text_model",
    "doc_metadata": [],
    "summary_index_status": null,
    "need_summary": false
  },
  "batch": "20250306150245647595"
}

承認

​
Authorization
string
header
必須

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

パスパラメータ

​
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 です。