ナレッジベース詳細を取得

GET

datasets

{dataset_id}

ナレッジベース詳細を取得

curl --request GET \
  --url https://{api_base_url}/datasets/{dataset_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/datasets/{dataset_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/datasets/{dataset_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/datasets/{dataset_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{api_base_url}/datasets/{dataset_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/datasets/{dataset_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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,
  "maintainer": "admin"
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Dataset api access is not enabled."
}

{
  "status": 404,
  "code": "not_found",
  "message": "Dataset not found."
}

Authorizations

Authorization

string

header

required

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

Path Parameters

dataset_id

string<uuid>

required

ナレッジベース ID です。

Response

ナレッジベースの詳細です。

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 | null

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

Show child attributes

tags

object[]

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

Show child attributes

doc_form

string

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

external_knowledge_info

object | null

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

Show child attributes

external_retrieval_model

object | null

外部ナレッジベースの検索設定です。内部ナレッジベースの場合は 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 | null

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

Show child attributes

is_published

boolean

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

total_documents

integer

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

total_available_documents

integer

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

enable_api

boolean

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

is_multimodal

boolean

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

maintainer

string | null

ナレッジベースのメンテナーの表示名です。設定されていない場合は null です。

partial_member_list

string[] | null

permission が partial_members の場合にアクセスを許可されたメンバーのアカウント ID です。更新レスポンスでは常に含まれ、詳細レスポンスでは permission が partial_members の場合にのみ含まれます。

Last modified on July 9, 2026

ナレッジベースリストを取得

ナレッジベースを更新

ナレッジベース詳細を取得

curl --request GET \
  --url https://{api_base_url}/datasets/{dataset_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/datasets/{dataset_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/datasets/{dataset_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/datasets/{dataset_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{api_base_url}/datasets/{dataset_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/datasets/{dataset_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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,
  "maintainer": "admin"
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Dataset api access is not enabled."
}

{
  "status": 404,
  "code": "not_found",
  "message": "Dataset not found."
}