メインコンテンツへスキップ
POST
/
datasets
/
{dataset_id}
/
document
/
create-by-text
Error
A valid request URL is required to generate request examples
{
  "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。

ボディ

application/json
​
name
string
必須

ドキュメントの名前。

​
text
string
必須

ドキュメントの完全なテキストコンテンツ。

​
indexing_technique
enum<string>

ドキュメントのインデックス化技術。

利用可能なオプション:
high_quality,
economy
​
doc_form
enum<string>

インデックス化されたコンテンツの形式。

利用可能なオプション:
text_model,
hierarchical_model,
qa_model
​
doc_language
string

ドキュメントの言語、Q&Aモードで重要。

例:

"Japanese"

​
process_rule
object

クリーニングとセグメント化を含む、ドキュメントを処理するためのルールセット。

​
retrieval_model
object
​
embedding_model
string

使用する埋め込みモデルの名前。

​
embedding_model_provider
string

埋め込みモデルのプロバイダー。

レスポンス

200 - application/json

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

​
document
object
​
batch
string

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