メインコンテンツへスキップ
POST
/
datasets
空のナレッジベースを作成
curl --request POST \
  --url http://{apiBaseUrl}/datasets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "indexing_technique": "high_quality",
  "permission": "only_me",
  "provider": "vendor",
  "external_knowledge_api_id": "<string>",
  "external_knowledge_id": "<string>",
  "embedding_model": "<string>",
  "embedding_model_provider": "<string>",
  "retrieval_model": {
    "search_method": "hybrid_search",
    "reranking_enable": true,
    "reranking_mode": {
      "reranking_provider_name": "<string>",
      "reranking_model_name": "<string>"
    },
    "top_k": 123,
    "score_threshold_enabled": true,
    "score_threshold": 123,
    "weights": 123
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "provider": "<string>",
  "permission": "<string>",
  "data_source_type": "<string>",
  "indexing_technique": "<string>",
  "app_count": 123,
  "document_count": 123,
  "word_count": 123,
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": 123,
  "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": 123,
  "embedding_model": "<string>",
  "embedding_model_provider": "<string>",
  "embedding_available": true
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required

ナレッジベースの名前。

​
description
string

ナレッジベースの説明（オプション）。

​
indexing_technique
enum<string>

使用するインデックス化技術。

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

ナレッジベースのアクセス権限。

利用可能なオプション:
only_me,
all_team_members,
partial_members
​
provider
enum<string>

ナレッジベースのプロバイダー。

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

外部ナレッジAPIのID（プロバイダーが'external'の場合）。

​
external_knowledge_id
string

外部ナレッジのID（プロバイダーが'external'の場合）。

​
embedding_model
string

埋め込みモデルの名前。

​
embedding_model_provider
string

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

​
retrieval_model
object

Response

データセットの作成に成功しました。

​
id
string<uuid>
​
name
string
​
description
string | null
​
provider
string
​
permission
string
​
data_source_type
string | null
​
indexing_technique
string | null
​
app_count
integer
​
document_count
integer
​
word_count
integer
​
created_by
string<uuid>
​
created_at
integer
​
updated_by
string<uuid>
​
updated_at
integer
​
embedding_model
string | null
​
embedding_model_provider
string | null
​
embedding_available
boolean | null