ナレッジベース設定を更新

ナレッジベースの埋め込みモデルまたは検索設定を変更します。コンテンツのインデックス前後でのモデル設定については、モデルと検索設定の変更を参照してください。

動作は、モデルがすでにアクティブかどうかによって異なります：

最初のドキュメントがインデックスされる前は、設定は保留中として保存され、200 が返ります。設定は最初のドキュメントのインデックス時に検証され、有効になります。embedding または retrieval を省略すると、そのグループは保留中の値のまま残ります。
モデルがアクティブになった後は 202 が返り、変更は移行として実行されます。移行が終わるまで migration.id で設定の移行を取得をポーリングし、その後で最終的な設定を読み取ってください。アクティブな埋め込みモデルを再送信する場合など、移行が不要な変更では 200 が返ります。

埋め込みモデルを変更すると、すべてのドキュメントが埋め込み直されます。推論モデルを含め、検索設定の変更は再構築なしで反映されます。インデックス済みのドキュメントは、ドキュメントを再インデックスで再インデックスするまで、以前のモデルが構築した内容のままです。

ルール：

embedding と retrieval の少なくとも一方を送信します。モデルがアクティブになった後は、1 回の呼び出しでどちらか一方だけを送信します。
retrieval には有効なリランクモデルが必要です。rerank.enabled: true と rerank.model を一緒に送信します。
retrieval には埋め込みモデルが必要です。同じ呼び出しで送信するか、事前に保存しておきます。そうでない場合は 409 が返ります。
scoreThreshold.enabled: true には scoreThreshold.value が必要です。

1 min read

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

Request example

curl --request PATCH \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "embedding": {
    "model": "text-embedding-3-small",
    "pluginId": "langgenius/openai",
    "provider": "openai"
  },
  "expectedRevision": 7,
  "retrieval": {
    "defaultMode": "fast",
    "reasoningModel": {
      "model": "gpt-4.1-mini",
      "pluginId": "langgenius/openai",
      "provider": "openai"
    },
    "rerank": {
      "enabled": true,
      "model": {
        "model": "rerank-v3.5",
        "pluginId": "langgenius/cohere",
        "provider": "cohere"
      }
    },
    "scoreThreshold": {
      "enabled": true,
      "stage": "mode-final",
      "value": 0.4
    },
    "topK": 10
  }
}'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
}
payload = {
    "embedding": {
        "model": "text-embedding-3-small",
        "pluginId": "langgenius/openai",
        "provider": "openai"
    },
    "expectedRevision": 7,
    "retrieval": {
        "defaultMode": "fast",
        "reasoningModel": {
            "model": "gpt-4.1-mini",
            "pluginId": "langgenius/openai",
            "provider": "openai"
        },
        "rerank": {
            "enabled": True,
            "model": {
                "model": "rerank-v3.5",
                "pluginId": "langgenius/cohere",
                "provider": "cohere"
            }
        },
        "scoreThreshold": {
            "enabled": True,
            "stage": "mode-final",
            "value": 0.4
        },
        "topK": 10
    }
}

response = requests.request("PATCH", url, headers=headers, json=payload)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "embedding": {
      "model": "text-embedding-3-small",
      "pluginId": "langgenius/openai",
      "provider": "openai"
    },
    "expectedRevision": 7,
    "retrieval": {
      "defaultMode": "fast",
      "reasoningModel": {
        "model": "gpt-4.1-mini",
        "pluginId": "langgenius/openai",
        "provider": "openai"
      },
      "rerank": {
        "enabled": true,
        "model": {
          "model": "rerank-v3.5",
          "pluginId": "langgenius/cohere",
          "provider": "cohere"
        }
      },
      "scoreThreshold": {
        "enabled": true,
        "stage": "mode-final",
        "value": 0.4
      },
      "topK": 10
    }
  })
});

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 => 'PATCH',
  CURLOPT_POSTFIELDS => '{
  "embedding": {
    "model": "text-embedding-3-small",
    "pluginId": "langgenius/openai",
    "provider": "openai"
  },
  "expectedRevision": 7,
  "retrieval": {
    "defaultMode": "fast",
    "reasoningModel": {
      "model": "gpt-4.1-mini",
      "pluginId": "langgenius/openai",
      "provider": "openai"
    },
    "rerank": {
      "enabled": true,
      "model": {
        "model": "rerank-v3.5",
        "pluginId": "langgenius/cohere",
        "provider": "cohere"
      }
    },
    "scoreThreshold": {
      "enabled": true,
      "stage": "mode-final",
      "value": 0.4
    },
    "topK": 10
  }
}',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
    'Content-Type: application/json',
  ],
]);

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

echo $response;

package main

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

func main() {
	url := "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings"
	payload := strings.NewReader("{\n  \"embedding\": {\n    \"model\": \"text-embedding-3-small\",\n    \"pluginId\": \"langgenius/openai\",\n    \"provider\": \"openai\"\n  },\n  \"expectedRevision\": 7,\n  \"retrieval\": {\n    \"defaultMode\": \"fast\",\n    \"reasoningModel\": {\n      \"model\": \"gpt-4.1-mini\",\n      \"pluginId\": \"langgenius/openai\",\n      \"provider\": \"openai\"\n    },\n    \"rerank\": {\n      \"enabled\": true,\n      \"model\": {\n        \"model\": \"rerank-v3.5\",\n        \"pluginId\": \"langgenius/cohere\",\n        \"provider\": \"cohere\"\n      }\n    },\n    \"scoreThreshold\": {\n      \"enabled\": true,\n      \"stage\": \"mode-final\",\n      \"value\": 0.4\n    },\n    \"topK\": 10\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\n  \"embedding\": {\n    \"model\": \"text-embedding-3-small\",\n    \"pluginId\": \"langgenius/openai\",\n    \"provider\": \"openai\"\n  },\n  \"expectedRevision\": 7,\n  \"retrieval\": {\n    \"defaultMode\": \"fast\",\n    \"reasoningModel\": {\n      \"model\": \"gpt-4.1-mini\",\n      \"pluginId\": \"langgenius/openai\",\n      \"provider\": \"openai\"\n    },\n    \"rerank\": {\n      \"enabled\": true,\n      \"model\": {\n        \"model\": \"rerank-v3.5\",\n        \"pluginId\": \"langgenius/cohere\",\n        \"provider\": \"cohere\"\n      }\n    },\n    \"scoreThreshold\": {\n      \"enabled\": true,\n      \"stage\": \"mode-final\",\n      \"value\": 0.4\n    },\n    \"topK\": 10\n  }\n}"))
    .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::Patch.new(url)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = '{
  "embedding": {
    "model": "text-embedding-3-small",
    "pluginId": "langgenius/openai",
    "provider": "openai"
  },
  "expectedRevision": 7,
  "retrieval": {
    "defaultMode": "fast",
    "reasoningModel": {
      "model": "gpt-4.1-mini",
      "pluginId": "langgenius/openai",
      "provider": "openai"
    },
    "rerank": {
      "enabled": true,
      "model": {
        "model": "rerank-v3.5",
        "pluginId": "langgenius/cohere",
        "provider": "cohere"
      }
    },
    "scoreThreshold": {
      "enabled": true,
      "stage": "mode-final",
      "value": 0.4
    },
    "topK": 10
  }
}'

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

Response

{
  "migration": null,
  "settings": {
    "active_profile_available": false,
    "active_profile_revisions": {
      "embedding": null,
      "retrieval": null
    },
    "capabilities": {
      "deep": false,
      "index": false,
      "ingest": true,
      "query": false,
      "research": false,
      "source_sync": true
    },
    "configuration_state": "active",
    "embedding": {
      "dimension": null,
      "model": "text-embedding-3-small",
      "plugin_id": "langgenius/openai",
      "provider": "openai",
      "revision": null,
      "vector_space_id": null
    },
    "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": null,
      "score_threshold": {
        "enabled": true,
        "stage": "mode-final",
        "value": 0.4
      },
      "top_k": 10
    },
    "revision": 8
  }
}

{
  "migration": {
    "candidate_publication_fingerprint": null,
    "changed_kind": "embedding",
    "checkpoint": "queued",
    "completed_at": null,
    "created_at": "2026-09-08T03:10:00Z",
    "error_code": null,
    "evaluation_summary": null,
    "id": "a7c3e9f1-2b4d-4c6e-8f0a-1b3d5f7a9c2e",
    "knowledge_space_id": "0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d",
    "rebuild_scope": "full-vector-space",
    "run_state": "queued",
    "updated_at": "2026-09-08T03:10:00Z"
  },
  "settings": {
    "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_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400,
  "violations": [
    {
      "field": [
        "expectedRevision"
      ],
      "type": "missing"
    }
  ]
}

{
  "code": "knowledge_fs_invalid_request",
  "failure": {
    "category": "validation",
    "code": "KNOWLEDGE_FS_INVALID_REQUEST",
    "message": "The Agent Knowledge Base request is invalid.",
    "retryPolicy": "never",
    "traceId": "9b7d3e1a-4c2f-4a8e-b6d0-5f1e2c3d4a5b"
  },
  "message": "The Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "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_conflict",
  "failure": {
    "action": "retry",
    "category": "conflict",
    "code": "KNOWLEDGE_FS_CONFLICT",
    "message": "The Agent Knowledge Base operation conflicts with the current resource state.",
    "retryPolicy": "manual",
    "traceId": "9b7d3e1a-4c2f-4a8e-b6d0-5f1e2c3d4a5b"
  },
  "message": "The Agent Knowledge Base operation conflicts with the current resource state.",
  "status": 409
}

{
  "code": "knowledge_fs_conflict",
  "failure": {
    "action": "retry",
    "category": "conflict",
    "code": "KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT",
    "message": "Knowledge space settings have changed. Reload the latest settings and review your changes before saving again.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "Knowledge space settings have changed. Reload the latest settings and review your changes before saving again.",
  "status": 409
}

{
  "code": "knowledge_fs_request_rejected",
  "message": "Agent Knowledge Base request was rejected.",
  "status": 422
}

{
  "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
}

patch/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/ の後のセグメントです。

Body

application/json

Any of

embeddingobjectrequired#

Responses

application/json

移行は開始されていません。設定が保留中として保存されたか、モデルがアクティブで変更に移行が不要でした。settings はナレッジベース設定を取得と同じ形式で、その revision を次回の更新で送信します。設定が保留中の間は、active_profile_available は false、capabilities.query も false のままです。

migrationobject#

ここでは常に null です。移行は開始されていません。

settingsobject#

Show child attributes

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 として送信します。このレスポンスにあるほかのリビジョンのフィールドは、この値とは別物です。

migrationobject#

この変更で開始された移行です。設定の移行を取得で追跡します。

Show child attributes

candidate_publication_fingerprintstring#

内部用です。移行の追跡には不要です。

changed_kindstring#

変更の対象で、embedding または retrieval です。

checkpointstring#

到達した最後のステップで、queued、candidate-built、evaluated、activated のいずれかです。移行が終了したかどうかは、run_state で判断してください。

completed_atstring#

移行が succeeded、failed、canceled のいずれかで終了した日時（ISO 8601）です。実行中は null です。

created_atstring#

移行の開始日時（ISO 8601）です。

error_codestring#

直近の失敗のコードです（例：PROFILE_MIGRATION_ATTEMPTS_EXHAUSTED、VECTOR_SPACE_QUOTA_EXCEEDED）。失敗がない場合は null です。

evaluation_summaryobject#

移行について記録された結果の、フラットなマップです。移行の追跡には必要ありません。記録されていない場合は null です。

idstring#

移行 ID です。設定の移行を取得に渡します。

knowledge_space_idstring#

ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。

rebuild_scopestring#

移行で再構築される範囲です：

full-vector-space：埋め込みモデルの変更により、すべてのドキュメントを埋め込み直します。
clone-publication：どの検索設定の変更でも、現在のインデックスを再利用します。
full-page-index-summary-outline：非推奨です。以前の移行では、引き続きこの値が返される場合があります。推論モデルを変更した場合は clone-publication が返ります。

run_statestring#

移行の進行状況です：

queued、running：処理中です。
succeeded：新しい設定が適用されています。
failed：停止しました。理由は error_code に示されます。変更を再度試す前に、ナレッジベース設定を取得でモデルを確認してください。
canceled：完了前に、同じ種類の新しい変更によってこの移行が置き換えられました。新しい移行を追跡してください。

updated_atstring#

移行が最後に変更された日時（ISO 8601）です。

settingsobject#

Show child attributes

active_profile_availableboolean#

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

active_profile_revisionsobject#

Show child attributes

embeddinginteger#

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

retrievalinteger#

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

capabilitiesobject#

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

Show child attributes

deepboolean#

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

indexboolean#

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

ingestboolean#

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

queryboolean#

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

researchboolean#

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

source_syncboolean#

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

configuration_statestring#

embeddingobject#

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#

Show child attributes

default_modestring#

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#

valuenumber#

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

top_kinteger#

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

revisioninteger#

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