ナレッジベース設定を取得

get/knowledge-fs/spaces/{knowledge_base_id}/settings

Request example

curl --request GET \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

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

func main() {
	url := "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings"

	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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

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

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

Response

{
  "active_profile_available": false,
  "active_profile_revisions": {
    "embedding": null,
    "retrieval": null
  },
  "capabilities": {
    "deep": false,
    "index": false,
    "ingest": false,
    "query": false,
    "research": false,
    "source_sync": false
  },
  "configuration_state": "setup-required",
  "embedding": null,
  "issues": [
    {
      "code": "missing",
      "field": "embedding",
      "retryable": false
    },
    {
      "code": "missing",
      "field": "reasoning",
      "retryable": false
    },
    {
      "code": "missing",
      "field": "rerank",
      "retryable": false
    }
  ],
  "retrieval": null,
  "revision": 1
}

{
  "active_profile_available": true,
  "active_profile_revisions": {
    "embedding": 2,
    "retrieval": 3
  },
  "capabilities": {
    "deep": true,
    "index": true,
    "ingest": true,
    "query": true,
    "research": true,
    "source_sync": true
  },
  "configuration_state": "active",
  "embedding": {
    "dimension": 1536,
    "model": "text-embedding-3-small",
    "plugin_id": "langgenius/openai",
    "provider": "openai",
    "revision": 2,
    "vector_space_id": "embedding-space-sha256:4f7c2d9a1b3e5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4"
  },
  "issues": [],
  "retrieval": {
    "default_mode": "fast",
    "reasoning_model": {
      "dimension": null,
      "model": "gpt-4.1-mini",
      "plugin_id": "langgenius/openai",
      "provider": "openai",
      "revision": null,
      "vector_space_id": null
    },
    "rerank": {
      "enabled": true,
      "model": {
        "model": "rerank-v3.5",
        "pluginId": "langgenius/cohere",
        "provider": "cohere"
      }
    },
    "revision": 3,
    "score_threshold": {
      "enabled": false,
      "stage": "mode-final",
      "value": null
    },
    "top_k": 10
  },
  "revision": 7
}

{
  "code": "knowledge_fs_invalid_credential",
  "message": "Invalid Agent Knowledge Base service credential.",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Authorization header must be provided and start with 'Bearer'",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Access token is invalid",
  "status": 401
}

{
  "code": "forbidden",
  "message": "Sorry, you have reached the knowledge base request rate limit of your subscription.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "message": "Agent Knowledge Base operation is not allowed.",
  "status": 403
}

{
  "code": "knowledge_fs_resource_not_found",
  "failure": {
    "category": "not_found",
    "code": "KNOWLEDGE_FS_NOT_FOUND",
    "message": "The requested Agent Knowledge Base resource was not found.",
    "retryPolicy": "never",
    "traceId": "9b7d3e1a-4c2f-4a8e-b6d0-5f1e2c3d4a5b"
  },
  "message": "The requested Agent Knowledge Base resource was not found.",
  "status": 404
}

{
  "code": "not_found",
  "message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.",
  "status": 404
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "message": "Agent Knowledge Base is unavailable.",
  "status": 502
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "failure": {
    "action": "contact_admin",
    "category": "internal",
    "code": "KNOWLEDGE_FS_INTERNAL_ERROR",
    "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
    "retryPolicy": "manual",
    "traceId": "9b7d3e1a-4c2f-4a8e-b6d0-5f1e2c3d4a5b"
  },
  "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
  "status": 502
}

{
  "code": "knowledge_fs_operation_unavailable",
  "message": "Agent Knowledge Base operation is not available.",
  "status": 503
}

{
  "code": "knowledge_fs_operation_unavailable",
  "failure": {
    "action": "retry",
    "category": "dependency",
    "code": "KNOWLEDGE_FS_UNAVAILABLE",
    "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
  "status": 503
}

get/knowledge-fs/spaces/{knowledge_base_id}/settings

Authorization

Authorizationstringheaderrequired#

すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。

Path parameters

knowledge_base_idstringrequired#

ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント（…/knowledge-fs/spaces/<knowledge base ID>）です。アドレスバーでは /datasets/new/ の後のセグメントです。

Responses

application/json

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

active_profile_availableboolean#

埋め込みモデルと検索設定の両方がアクティブな場合は true です。最初のドキュメントのインデックス処理が済むとアクティブになります。

active_profile_revisionsobject#

アクティブなモデルのリビジョンです。最初のドキュメントのインデックス処理が済むまでは、いずれも null です。プロファイルがアクティブになった後は、ナレッジベース設定を更新による変更は設定の移行として実行されます。

Show child attributes

embeddinginteger#

アクティブな埋め込みモデルのリビジョンです。

retrievalinteger#

アクティブな検索設定のリビジョンです。

capabilitiesobject#

公開済みの設定で各機能を使える状態かどうかを示します。3 つのフラグは検索の深度に対応し、query は fast を表します。

特定の深度で使えるかどうかを確認するには、その深度を mode として明示的に送信し、対応するフラグを確認してください。mode を省略したクエリの深度を判断するために、保留中の retrieval.default_mode を使用しないでください。

Show child attributes

deepboolean#

deep の深度でクエリを実行できます。

indexboolean#

ドキュメントのインデックス処理を実行できます。モデルがアクティブです。

ingestboolean#

ドキュメントを追加できます。モデルがアクティブであるか、保留中の設定が揃っていて、最初のドキュメントでアクティブ化できる状態です。

queryboolean#

fast の深度でクエリを実行できます。

researchboolean#

research の深度でクエリを実行できます。

source_syncboolean#

ソースを同期できます。条件は ingest と同じです。

configuration_statestring#

埋め込みモデルと完全な検索設定（有効なリランクモデルを含む）が保存されている場合は active です。いずれかが欠けている場合は setup-required です。最初のドキュメントのインデックス処理中に、保留中の設定が検証に失敗した場合は validation-failed です。失敗した設定は issues に示されます。

embeddingobject#

埋め込みモデルです。保留中の選択が保存されている場合はその選択、それ以外の場合はアクティブなモデルです。保留中の選択は、クエリが現在使用しているモデルと異なる場合があります。設定されていない場合は null です。

dimension、revision、vector_space_id は参考情報であり、これらを受け取る操作はありません。

Show child attributes

dimensioninteger#

ベクトルの次元数で、モデルの初回使用時に確認されます。モデルがアクティブになるまでは null です。

modelstring#

モデル名です。

plugin_idstring#

モデルを提供するプラグインです。organization/plugin_name の形式で指定します。

providerstring#

プラグイン内のプロバイダー名です。

revisioninteger#

アクティブな埋め込みモデルのリビジョンです。モデルがアクティブになるまでは null です。

vector_space_idstring#

モデルのベクトルの保存先を識別します。モデルがアクティブになるまでは null です。

issuesobject[]#

ナレッジベースが使用可能になるのを妨げている問題です。問題がない場合は空です。

Show child attributes

codestring#

設定の問題点です：

missing：選択されていないか、リランクが無効です。
validation_failed、unavailable、incompatible：保留中の設定が検証に失敗しました。incompatible の場合は、モデルが対応するタスク、埋め込みの次元数、選択したモデルをプロバイダーが返したかどうかを確認してください。
binding_missing：公開済みのコンテンツが、設定されたモデルを使用できる状態になっていません。Dify でインデックス処理の進捗を確認してください。
publication に対する unavailable：公開済みのコンテンツが、すべての深度に対応できる状態になっていません。

fieldstring#

対象の設定で、embedding、reasoning、rerank、publication（公開済みのコンテンツ）のいずれかです。

retryableboolean#

設定を変更しなくても、時間をおいて再試行すれば問題が解消するかどうかです。

retrievalobject#

検索設定です。保留中の選択が保存されている場合はその選択、それ以外の場合はアクティブな設定です。保留中の選択は、クエリが現在使用している設定と異なる場合があります。設定されていない場合は null です。

Show child attributes

default_modestring#

返された検索設定におけるデフォルトの深度で、fast、deep、research のいずれかです。mode を省略したクエリは、公開済みのデフォルトを使用します。保留中の設定が返されている場合、公開済みのデフォルトはこの値と異なることがあります。

reasoning_modelobject#

システムの推論モデルです。dimension、revision、vector_space_id は常に null です。

Show child attributes

dimensioninteger#

常に null です。

modelstring#

モデル名です。

plugin_idstring#

モデルを提供するプラグインです。organization/plugin_name の形式で指定します。

providerstring#

プラグイン内のプロバイダー名です。

revisioninteger#

常に null です。

vector_space_idstring#

常に null です。

rerankobject#

リランクモデルです。このレスポンスのほかの部分とは異なり、model オブジェクトではキャメルケースのキー pluginId が使われます。

Show child attributes

enabledboolean#

検索されたチャンクをリランクするかどうかです。

modelobject#

選択されたリランクモデルです。リランクモデルが設定されていない場合は null です。

Show child attributes

modelstring#

モデル名です。

pluginIdstring#

モデルを提供するプラグインです。organization/plugin_name の形式で指定します。

providerstring#

プラグイン内のプロバイダー名です。

revisioninteger#

アクティブな検索設定のリビジョンです。設定が保留中の間は null です。

score_thresholdobject#

スコアの低いチャンクを除外するスコアしきい値です。

Show child attributes

enabledboolean#

しきい値を適用するかどうかです。

stagestring#

しきい値を適用する段階です。mode-final は、実行される検索の深度の最終スコアに適用します。fast と deep ではリランクスコア、research では PageIndex スコアです。rerank は同じ設定の旧名称です。

valuenumber#

しきい値となるスコアで、0 から 1 の値です。設定されていない場合は null です。

top_kinteger#

1 回の検索で返すチャンクの最大数です。

revisioninteger#

設定のリビジョンです。ナレッジベース設定を更新で expectedRevision として送信します。このレスポンスにあるほかのリビジョンのフィールドは、この値とは別物です。

ソースの実行を再試行ナレッジベース設定を更新