空のナレッジベースを作成

新しい空のナレッジベースを作成します。作成後、テキストからドキュメントを作成 または ファイルからドキュメントを作成 を使用してドキュメントを追加します。

POST /datasets

Error

A valid request URL is required to generate request examples

200

{
  "id": "c42e2a6e-40b3-4330-96f8-f1e4d768e8c9",
  "name": "Product Documentation",
  "description": "プロダクト API 技術ドキュメント",
  "provider": "vendor",
  "permission": "only_me",
  "data_source_type": null,
  "indexing_technique": "high_quality",
  "app_count": 0,
  "document_count": 0,
  "word_count": 0,
  "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "author_name": "admin",
  "created_at": 1741267200,
  "updated_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "updated_at": 1741267200,
  "embedding_model": "text-embedding-3-small",
  "embedding_model_provider": "openai",
  "embedding_available": true,
  "retrieval_model_dict": {
    "search_method": "semantic_search",
    "reranking_enable": false,
    "reranking_mode": null,
    "reranking_model": {
      "reranking_provider_name": "",
      "reranking_model_name": ""
    },
    "weights": null,
    "top_k": 3,
    "score_threshold_enabled": false,
    "score_threshold": null
  },
  "tags": [],
  "doc_form": "text_model",
  "external_knowledge_info": null,
  "external_retrieval_model": null,
  "doc_metadata": [],
  "built_in_field_enabled": true,
  "pipeline_id": null,
  "runtime_mode": null,
  "chunk_structure": null,
  "icon_info": null,
  "summary_index_setting": null,
  "is_published": false,
  "total_documents": 0,
  "total_available_documents": 0,
  "enable_api": true,
  "is_multimodal": false
}

承認

Authorization · string · header · 必須

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

ボディ

application/json

name · string · 必須

ナレッジベース名。

Required string length: 1 - 40

description · string · デフォルト: ""

ナレッジベースの説明です。

Maximum string length: 400

indexing_technique · enum<string> | null

high_quality は埋め込みモデルを使用した精密検索、economy はキーワードベースのインデキシングです。

利用可能なオプション: high_quality, economy

permission · enum<string> · デフォルト: only_me

このナレッジベースにアクセスできるユーザーを制御します。only_me は作成者のみに制限、all_team_members はワークスペース全体にアクセスを許可、partial_members は指定されたメンバーにアクセスを許可します。

利用可能なオプション: only_me, all_team_members, partial_members

provider · enum<string> · デフォルト: vendor

vendor は内部ナレッジベース、external は外部ナレッジベースです。

利用可能なオプション: vendor, external

embedding_model · string

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

embedding_model_provider · string

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

retrieval_model · object

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

Show child attributes

external_knowledge_api_id · string

外部ナレッジ API 接続の ID です。

external_knowledge_id · string

外部ナレッジベースの ID です。

summary_index_setting · object

サマリーインデックスの設定です。

Show child attributes

レスポンス

200

application/json

ナレッジベースが正常に作成されました。

id · string

ナレッジベースの一意識別子です。

name · string

ナレッジベースの表示名です。ワークスペース内で一意です。

description · string

ナレッジベースの目的または内容を説明するオプションのテキストです。

provider · string

プロバイダータイプです。内部管理の場合は vendor、外部ナレッジベース接続の場合は external です。

permission · string

このナレッジベースにアクセスできるユーザーを制御します。指定可能な値：only_me、all_team_members、partial_members。

data_source_type · string

ドキュメントのデータソースタイプです。まだ設定されていない場合は null です。

indexing_technique · string

high_quality は埋め込みモデルを使用した精密検索、economy はキーワードベースのインデキシングです。

app_count · integer

現在このナレッジベースを使用しているアプリケーションの数です。

document_count · integer

ナレッジベース内のドキュメント総数です。

word_count · integer

全ドキュメントの合計単語数です。

created_by · string

ナレッジベースを作成したユーザーの ID です。

author_name · string

作成者の表示名です。

created_at · number

作成タイムスタンプ（Unix エポック、秒単位）です。

updated_by · string

ナレッジベースを最後に更新したユーザーの ID です。

updated_at · number

最終更新タイムスタンプ（Unix エポック、秒単位）です。

embedding_model · string

インデックス作成に使用される埋め込みモデルの名前です。

embedding_model_provider · string

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

embedding_available · boolean

設定された埋め込みモデルが現在利用可能かどうかです。

retrieval_model_dict · object

ナレッジベースの検索設定です。

Show child attributes

summary_index_setting · object

サマリーインデックスの設定です。

Show child attributes

tags · object[]

このナレッジベースに関連付けられたタグです。

Show child attributes

doc_form · string

ドキュメントのチャンキングモードです。text_model は標準テキストチャンキング、hierarchical_model は親子構造、qa_model は QA ペア抽出を示します。

external_knowledge_info · object

外部ナレッジベースの接続詳細です。provider が external の場合に存在します。

Show child attributes

external_retrieval_model · object

外部ナレッジベースの検索設定です。内部ナレッジベースの場合は null です。

Show child attributes

doc_metadata · object[]

ナレッジベースのメタデータフィールド定義です。

Show child attributes

built_in_field_enabled · boolean

組み込みメタデータフィールド（例：document_name、uploader）が有効かどうかです。

pipeline_id · string | null

カスタム処理パイプラインが設定されている場合のパイプライン ID です。

runtime_mode · string | null

ランタイム処理モードです。

chunk_structure · string | null

チャンク構造の設定です。

icon_info · object

ナレッジベースのアイコン表示設定です。

Show child attributes

is_published · boolean

ナレッジベースが公開済みかどうかです。

total_documents · integer

ドキュメントの合計数です。

total_available_documents · integer

有効で利用可能なドキュメントの数です。

enable_api · boolean

このナレッジベースで API アクセスが有効かどうかです。

is_multimodal · boolean

マルチモーダルコンテンツ処理が有効かどうかです。