ナレッジベースを更新

patch/datasets/{dataset_id}

Request example

curl --request PATCH \
  --url https://api.dify.ai/v1/datasets/{dataset_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "embedding_model": "<string>",
  "embedding_model_provider": "<string>",
  "external_knowledge_api_id": "<string>",
  "external_knowledge_id": "<string>",
  "external_retrieval_model": {
    "score_threshold": 1,
    "score_threshold_enabled": true,
    "top_k": 1
  },
  "indexing_technique": "high_quality",
  "name": "<string>",
  "partial_member_list": [
    {
      "user_id": "<string>"
    }
  ],
  "permission": "only_me",
  "retrieval_model": {
    "metadata_filtering_conditions": {
      "conditions": [
        {
          "comparison_operator": "contains",
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "logical_operator": "and"
    },
    "reranking_enable": true,
    "reranking_mode": "reranking_model",
    "reranking_model": {
      "reranking_model_name": "<string>",
      "reranking_provider_name": "<string>"
    },
    "score_threshold": 1,
    "score_threshold_enabled": true,
    "search_method": "keyword_search",
    "top_k": 1,
    "weights": {
      "keyword_setting": {
        "keyword_weight": 1
      },
      "vector_setting": {
        "embedding_model_name": "<string>",
        "embedding_provider_name": "<string>",
        "vector_weight": 1
      },
      "weight_type": "semantic_first"
    }
  }
}'

import requests

url = "https://api.dify.ai/v1/datasets/{dataset_id}"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
}
payload = {
    "description": "<string>",
    "embedding_model": "<string>",
    "embedding_model_provider": "<string>",
    "external_knowledge_api_id": "<string>",
    "external_knowledge_id": "<string>",
    "external_retrieval_model": {
        "score_threshold": 1,
        "score_threshold_enabled": True,
        "top_k": 1
    },
    "indexing_technique": "high_quality",
    "name": "<string>",
    "partial_member_list": [
        {
            "user_id": "<string>"
        }
    ],
    "permission": "only_me",
    "retrieval_model": {
        "metadata_filtering_conditions": {
            "conditions": [
                {
                    "comparison_operator": "contains",
                    "name": "<string>",
                    "value": "<string>"
                }
            ],
            "logical_operator": "and"
        },
        "reranking_enable": True,
        "reranking_mode": "reranking_model",
        "reranking_model": {
            "reranking_model_name": "<string>",
            "reranking_provider_name": "<string>"
        },
        "score_threshold": 1,
        "score_threshold_enabled": True,
        "search_method": "keyword_search",
        "top_k": 1,
        "weights": {
            "keyword_setting": {
                "keyword_weight": 1
            },
            "vector_setting": {
                "embedding_model_name": "<string>",
                "embedding_provider_name": "<string>",
                "vector_weight": 1
            },
            "weight_type": "semantic_first"
        }
    }
}

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

print(response.text)

const response = await fetch('https://api.dify.ai/v1/datasets/{dataset_id}', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "description": "<string>",
    "embedding_model": "<string>",
    "embedding_model_provider": "<string>",
    "external_knowledge_api_id": "<string>",
    "external_knowledge_id": "<string>",
    "external_retrieval_model": {
      "score_threshold": 1,
      "score_threshold_enabled": true,
      "top_k": 1
    },
    "indexing_technique": "high_quality",
    "name": "<string>",
    "partial_member_list": [
      {
        "user_id": "<string>"
      }
    ],
    "permission": "only_me",
    "retrieval_model": {
      "metadata_filtering_conditions": {
        "conditions": [
          {
            "comparison_operator": "contains",
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "logical_operator": "and"
      },
      "reranking_enable": true,
      "reranking_mode": "reranking_model",
      "reranking_model": {
        "reranking_model_name": "<string>",
        "reranking_provider_name": "<string>"
      },
      "score_threshold": 1,
      "score_threshold_enabled": true,
      "search_method": "keyword_search",
      "top_k": 1,
      "weights": {
        "keyword_setting": {
          "keyword_weight": 1
        },
        "vector_setting": {
          "embedding_model_name": "<string>",
          "embedding_provider_name": "<string>",
          "vector_weight": 1
        },
        "weight_type": "semantic_first"
      }
    }
  })
});

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/datasets/{dataset_id}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'PATCH',
  CURLOPT_POSTFIELDS => '{
  "description": "<string>",
  "embedding_model": "<string>",
  "embedding_model_provider": "<string>",
  "external_knowledge_api_id": "<string>",
  "external_knowledge_id": "<string>",
  "external_retrieval_model": {
    "score_threshold": 1,
    "score_threshold_enabled": true,
    "top_k": 1
  },
  "indexing_technique": "high_quality",
  "name": "<string>",
  "partial_member_list": [
    {
      "user_id": "<string>"
    }
  ],
  "permission": "only_me",
  "retrieval_model": {
    "metadata_filtering_conditions": {
      "conditions": [
        {
          "comparison_operator": "contains",
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "logical_operator": "and"
    },
    "reranking_enable": true,
    "reranking_mode": "reranking_model",
    "reranking_model": {
      "reranking_model_name": "<string>",
      "reranking_provider_name": "<string>"
    },
    "score_threshold": 1,
    "score_threshold_enabled": true,
    "search_method": "keyword_search",
    "top_k": 1,
    "weights": {
      "keyword_setting": {
        "keyword_weight": 1
      },
      "vector_setting": {
        "embedding_model_name": "<string>",
        "embedding_provider_name": "<string>",
        "vector_weight": 1
      },
      "weight_type": "semantic_first"
    }
  }
}',
  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/datasets/{dataset_id}"
	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"embedding_model\": \"<string>\",\n  \"embedding_model_provider\": \"<string>\",\n  \"external_knowledge_api_id\": \"<string>\",\n  \"external_knowledge_id\": \"<string>\",\n  \"external_retrieval_model\": {\n    \"score_threshold\": 1,\n    \"score_threshold_enabled\": true,\n    \"top_k\": 1\n  },\n  \"indexing_technique\": \"high_quality\",\n  \"name\": \"<string>\",\n  \"partial_member_list\": [\n    {\n      \"user_id\": \"<string>\"\n    }\n  ],\n  \"permission\": \"only_me\",\n  \"retrieval_model\": {\n    \"metadata_filtering_conditions\": {\n      \"conditions\": [\n        {\n          \"comparison_operator\": \"contains\",\n          \"name\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"logical_operator\": \"and\"\n    },\n    \"reranking_enable\": true,\n    \"reranking_mode\": \"reranking_model\",\n    \"reranking_model\": {\n      \"reranking_model_name\": \"<string>\",\n      \"reranking_provider_name\": \"<string>\"\n    },\n    \"score_threshold\": 1,\n    \"score_threshold_enabled\": true,\n    \"search_method\": \"keyword_search\",\n    \"top_k\": 1,\n    \"weights\": {\n      \"keyword_setting\": {\n        \"keyword_weight\": 1\n      },\n      \"vector_setting\": {\n        \"embedding_model_name\": \"<string>\",\n        \"embedding_provider_name\": \"<string>\",\n        \"vector_weight\": 1\n      },\n      \"weight_type\": \"semantic_first\"\n    }\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/datasets/{dataset_id}"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\n  \"description\": \"<string>\",\n  \"embedding_model\": \"<string>\",\n  \"embedding_model_provider\": \"<string>\",\n  \"external_knowledge_api_id\": \"<string>\",\n  \"external_knowledge_id\": \"<string>\",\n  \"external_retrieval_model\": {\n    \"score_threshold\": 1,\n    \"score_threshold_enabled\": true,\n    \"top_k\": 1\n  },\n  \"indexing_technique\": \"high_quality\",\n  \"name\": \"<string>\",\n  \"partial_member_list\": [\n    {\n      \"user_id\": \"<string>\"\n    }\n  ],\n  \"permission\": \"only_me\",\n  \"retrieval_model\": {\n    \"metadata_filtering_conditions\": {\n      \"conditions\": [\n        {\n          \"comparison_operator\": \"contains\",\n          \"name\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"logical_operator\": \"and\"\n    },\n    \"reranking_enable\": true,\n    \"reranking_mode\": \"reranking_model\",\n    \"reranking_model\": {\n      \"reranking_model_name\": \"<string>\",\n      \"reranking_provider_name\": \"<string>\"\n    },\n    \"score_threshold\": 1,\n    \"score_threshold_enabled\": true,\n    \"search_method\": \"keyword_search\",\n    \"top_k\": 1,\n    \"weights\": {\n      \"keyword_setting\": {\n        \"keyword_weight\": 1\n      },\n      \"vector_setting\": {\n        \"embedding_model_name\": \"<string>\",\n        \"embedding_provider_name\": \"<string>\",\n        \"vector_weight\": 1\n      },\n      \"weight_type\": \"semantic_first\"\n    }\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/datasets/{dataset_id}')

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 = '{
  "description": "<string>",
  "embedding_model": "<string>",
  "embedding_model_provider": "<string>",
  "external_knowledge_api_id": "<string>",
  "external_knowledge_id": "<string>",
  "external_retrieval_model": {
    "score_threshold": 1,
    "score_threshold_enabled": true,
    "top_k": 1
  },
  "indexing_technique": "high_quality",
  "name": "<string>",
  "partial_member_list": [
    {
      "user_id": "<string>"
    }
  ],
  "permission": "only_me",
  "retrieval_model": {
    "metadata_filtering_conditions": {
      "conditions": [
        {
          "comparison_operator": "contains",
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "logical_operator": "and"
    },
    "reranking_enable": true,
    "reranking_mode": "reranking_model",
    "reranking_model": {
      "reranking_model_name": "<string>",
      "reranking_provider_name": "<string>"
    },
    "score_threshold": 1,
    "score_threshold_enabled": true,
    "search_method": "keyword_search",
    "top_k": 1,
    "weights": {
      "keyword_setting": {
        "keyword_weight": 1
      },
      "vector_setting": {
        "embedding_model_name": "<string>",
        "embedding_provider_name": "<string>",
        "vector_weight": 1
      },
      "weight_type": "semantic_first"
    }
  }
}'

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

Response

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

{
  "code": "invalid_param",
  "message": "No Embedding Model available. Please configure a valid provider in the Settings -> Model Provider.",
  "status": 400
}

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

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

{
  "code": "forbidden",
  "message": "The API key is not authorized to access this knowledge base.",
  "status": 403
}

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

patch/datasets/{dataset_id}

Authorization

Authorizationstringheaderrequired#

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

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

Path parameters

dataset_idstringrequired#

ナレッジベース ID。ナレッジベースリストを取得で取得します。スコープを限定したキーでは、Dify の URL から ID をコピーしてください。

Body

application/json

descriptionstring#

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

Length: max 400

embedding_modelstring#

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

embedding_model_providerstring#

埋め込みモデルプロバイダーの識別子です。organization/plugin_name/provider_name の形式です（例：langgenius/openai/openai）。openai のような短縮名は langgenius/<name>/<name> に展開され、langgenius が公開したプラグインでのみ機能します。

有効な値は利用可能なモデルを取得で model_type=text-embedding を指定した際の provider フィールドから取得します。

external_knowledge_api_idstring#

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

external_knowledge_idstring#

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

external_retrieval_modelobject#

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

Show child attributes

score_thresholdnumber#

結果フィルタリング用の最小関連性スコア閾値です。

score_threshold_enabledboolean#

スコア閾値フィルタリングが有効かどうかです。

top_kinteger#

返す結果の最大数です。

indexing_techniqueenum<string>#

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

Options:high_qualityeconomy

namestring#

ナレッジベース名。

Length: 1–40

partial_member_listobject[]#

permission が partial_members の場合にアクセス権を持つチームメンバーのリストです。

Show child attributes

user_idstring#

アクセス権を付与するチームメンバーの ID です。

permissionenum<string>#

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

Options:only_meall_team_memberspartial_members

retrieval_modelobject#

Show child attributes

metadata_filtering_conditionsobject#

ドキュメントのメタデータが指定した条件に一致するチャンクのみを取得対象に絞り込みます。条件はサーバーサイドで評価されます。

Show child attributes

conditionsobject[]#

評価するメタデータ条件のリストです。

Show child attributes

comparison_operatorenum<string>required#

適用する比較方法です。メタデータのタイプ別：

文字列または配列のメタデータ：contains、not contains、start with、end with、is、is not、empty、not empty、in、not in
数値メタデータ：=、≠、>、<、≥、≤
時刻メタデータ：before、after

Options:containsnot containsstart withend withisis notemptynot emptyinnot in=≠><≥≤beforeafter

namestringrequired#

比較対象とするメタデータフィールド名です。

valuestring · string[] · number#

比較対象の値です。型は comparison_operator によって異なります。ほとんどの文字列演算子では文字列、in および not in では文字列配列、数値演算子では数値、empty および not empty では省略します。

logical_operatorenum<string>#

複数の条件を組み合わせる方法です。

Default: "and"

Options:andor

reranking_enablebooleanrequired#

リランキングが有効かどうかです。

reranking_modeenum<string>#

リランキングモードです。reranking_enable が true の場合は必須です。

Options:reranking_modelweighted_score

reranking_modelobject#

リランキングモデルの設定です。

Show child attributes

reranking_model_namestring#

リランキングモデル名です。

reranking_provider_namestring#

リランクモデルプロバイダーの識別子です。organization/plugin_name/provider_name の形式です（例：langgenius/cohere/cohere）。cohere のような短縮名は langgenius/<name>/<name> に展開され、langgenius が公開したプラグインでのみ機能します。

有効な値は利用可能なモデルを取得で model_type=rerank を指定した際の provider フィールドから取得します。

score_thresholdnumber#

結果の最小関連性スコアです。score_threshold_enabled が true の場合にのみ有効です。

score_threshold_enabledbooleanrequired#

スコア閾値フィルタリングが有効かどうかです。

search_methodenum<string>required#

検索に使用される検索メソッドです。

Options:keyword_searchsemantic_searchfull_text_searchhybrid_search

top_kintegerrequired#

返す結果の最大数です。

weightsobject#

ハイブリッド検索の重み設定です。

Show child attributes

keyword_settingobject#

キーワード検索の重み設定です。

Show child attributes

keyword_weightnumber#

キーワード検索結果に割り当てられた重みです。

vector_settingobject#

セマンティック検索の重み設定です。

Show child attributes

embedding_model_namestring#

ベクトル検索に使用される埋め込みモデルの名前です。

embedding_provider_namestring#

ベクトル検索に使用される埋め込みモデルのプロバイダーです。

vector_weightnumber#

セマンティック（ベクトル）検索結果に割り当てられた重みです。

weight_typeenum<string>#

セマンティック検索とキーワード検索の重みを調整するための戦略です。

Options:semantic_firstkeyword_firstcustomized

Responses

application/json

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

app_countinteger#

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

author_namestring#

作成者の表示名です。

built_in_field_enabledboolean#

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

chunk_structurestring#

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

created_atnumber#

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

created_bystring#

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

data_source_typestring#

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

descriptionstring#

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

doc_formstring#

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

doc_metadataobject[]#

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

Show child attributes

idstring#

メタデータフィールドの識別子です。

namestring#

メタデータフィールド名です。

typestring#

メタデータフィールドの値の種類です。

document_countinteger#

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

embedding_availableboolean#

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

embedding_modelstring#

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

embedding_model_providerstring#

埋め込みモデルプロバイダーの識別子です。organization/plugin_name/provider_name の形式です（例：langgenius/openai/openai）。以前のナレッジベースでは短縮形（例：openai）が返される場合があります。

enable_apiboolean#

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

external_knowledge_infoobject#

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

Show child attributes

external_knowledge_api_endpointstring#

外部ナレッジ API のエンドポイント URL です。

external_knowledge_api_idstring#

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

external_knowledge_api_namestring#

外部ナレッジ API の表示名です。

external_knowledge_idstring#

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

external_retrieval_modelobject#

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

Show child attributes

score_thresholdnumber#

最小関連性スコアのしきい値です。

score_threshold_enabledboolean#

スコア閾値フィルタリングが有効かどうかです。

top_kinteger#

外部ナレッジベースから返す結果の最大数です。

icon_infoobject#

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

Show child attributes

iconstring#

アイコン識別子または絵文字です。

icon_backgroundstring#

アイコンの背景色です。

icon_typestring#

アイコンの種類です。

icon_urlstring#

カスタムアイコン画像の URL です。

idstring#

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

indexing_techniquestring#

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

is_multimodalboolean#

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

is_publishedboolean#

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

maintainerstring#

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

namestring#

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

partial_member_liststring[]#

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

permissionstring#

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

pipeline_idstring#

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

providerstring#

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

retrieval_model_dictobject#

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

Show child attributes

reranking_enableboolean#

リランキングが有効かどうかです。

reranking_modestring#

リランキングモードです。reranking_model はモデルベースのリランキング、weighted_score はスコアベースの重み付けを示します。リランキングが無効の場合は null です。

reranking_modelobject#

リランキングモデルの設定です。

Show child attributes

reranking_model_namestring#

リランキングモデル名です。

reranking_provider_namestring#

リランクモデルプロバイダーの識別子です。organization/plugin_name/provider_name の形式です（例：langgenius/cohere/cohere）。以前のナレッジベースでは短縮形（例：cohere）が返される場合があります。

score_thresholdnumber#

結果の最小関連性スコアです。score_threshold_enabled が true の場合にのみ有効です。

score_threshold_enabledboolean#

スコア閾値フィルタリングが有効かどうかです。

search_methodstring#

検索に使用する検索方法です。keyword_search はキーワードマッチング、semantic_search は埋め込みベースの類似度検索、full_text_search は全文インデックス検索、hybrid_search はセマンティックとキーワードの組み合わせ検索を示します。

top_kinteger#

返す結果の最大数です。

weightsobject#

ハイブリッド検索の重み設定です。

Show child attributes

keyword_settingobject#

キーワード検索の重み設定です。

Show child attributes

keyword_weightnumber#

キーワード検索結果に割り当てられた重みです。

vector_settingobject#

セマンティック検索の重み設定です。

Show child attributes

embedding_model_namestring#

ベクトル検索に使用される埋め込みモデルの名前です。

embedding_provider_namestring#

ベクトル検索に使用される埋め込みモデルのプロバイダーです。

vector_weightnumber#

セマンティック（ベクトル）検索結果に割り当てられた重みです。

weight_typestring#

セマンティック検索とキーワード検索の重みを調整するための戦略です。

runtime_modestring#

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

summary_index_settingobject#

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

Show child attributes

enableboolean#

サマリーインデックスが有効かどうかです。

model_namestring#

要約生成に使用されるモデルの名前です。

model_provider_namestring#

要約生成モデルのプロバイダーです。

summary_promptstring#

要約生成に使用されるプロンプトテンプレートです。

tagsobject[]#

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

Show child attributes

idstring#

タグ識別子です。

namestring#

Tag name.

typestring#

タグタイプです。ナレッジベースタグの場合は常に knowledge です。

total_available_documentsinteger#

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

total_documentsinteger#

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

updated_atnumber#

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

updated_bystring#

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

word_countinteger#

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

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