ナレッジベースを更新
既存のナレッジベースの名前、説明、権限、または検索設定を更新します。リクエストボディで指定されたフィールドのみが更新されます。
curl --request PATCH \
--url https://{api_base_url}/datasets/{dataset_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"embedding_model": "<string>",
"embedding_model_provider": "<string>",
"partial_member_list": [
{
"user_id": "<string>"
}
],
"external_retrieval_model": {
"top_k": 123,
"score_threshold": 123,
"score_threshold_enabled": true
},
"external_knowledge_id": "<string>",
"external_knowledge_api_id": "<string>"
}
'import requests
url = "https://{api_base_url}/datasets/{dataset_id}"
payload = {
"name": "<string>",
"description": "<string>",
"embedding_model": "<string>",
"embedding_model_provider": "<string>",
"partial_member_list": [{ "user_id": "<string>" }],
"external_retrieval_model": {
"top_k": 123,
"score_threshold": 123,
"score_threshold_enabled": True
},
"external_knowledge_id": "<string>",
"external_knowledge_api_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
embedding_model: '<string>',
embedding_model_provider: '<string>',
partial_member_list: [{user_id: '<string>'}],
external_retrieval_model: {top_k: 123, score_threshold: 123, score_threshold_enabled: true},
external_knowledge_id: '<string>',
external_knowledge_api_id: '<string>'
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'embedding_model' => '<string>',
'embedding_model_provider' => '<string>',
'partial_member_list' => [
[
'user_id' => '<string>'
]
],
'external_retrieval_model' => [
'top_k' => 123,
'score_threshold' => 123,
'score_threshold_enabled' => true
],
'external_knowledge_id' => '<string>',
'external_knowledge_api_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{api_base_url}/datasets/{dataset_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"embedding_model\": \"<string>\",\n \"embedding_model_provider\": \"<string>\",\n \"partial_member_list\": [\n {\n \"user_id\": \"<string>\"\n }\n ],\n \"external_retrieval_model\": {\n \"top_k\": 123,\n \"score_threshold\": 123,\n \"score_threshold_enabled\": true\n },\n \"external_knowledge_id\": \"<string>\",\n \"external_knowledge_api_id\": \"<string>\"\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))
}HttpResponse<String> response = Unirest.patch("https://{api_base_url}/datasets/{dataset_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"embedding_model\": \"<string>\",\n \"embedding_model_provider\": \"<string>\",\n \"partial_member_list\": [\n {\n \"user_id\": \"<string>\"\n }\n ],\n \"external_retrieval_model\": {\n \"top_k\": 123,\n \"score_threshold\": 123,\n \"score_threshold_enabled\": true\n },\n \"external_knowledge_id\": \"<string>\",\n \"external_knowledge_api_id\": \"<string>\"\n}")
.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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"embedding_model\": \"<string>\",\n \"embedding_model_provider\": \"<string>\",\n \"partial_member_list\": [\n {\n \"user_id\": \"<string>\"\n }\n ],\n \"external_retrieval_model\": {\n \"top_k\": 123,\n \"score_threshold\": 123,\n \"score_threshold_enabled\": true\n },\n \"external_knowledge_id\": \"<string>\",\n \"external_knowledge_api_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例:Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。API Key が欠落または無効な場合、HTTP 401 とエラーコード unauthorized が返されます。
Path Parameters
ナレッジベース ID です。
Body
ナレッジベース名。
1 - 40ナレッジベースの説明です。
400high_quality は埋め込みモデルを使用した精密検索、economy はキーワードベースのインデキシングです。
high_quality, economy このナレッジベースにアクセスできるユーザーを制御します。only_me は作成者のみに制限、all_team_members はワークスペース全体にアクセスを許可、partial_members は指定されたメンバーにアクセスを許可します。
only_me, all_team_members, partial_members 埋め込みモデル名です。利用可能なモデルを取得 で model_type=text-embedding を指定した際の model フィールドの値を使用します。
埋め込みモデルプロバイダーです。利用可能なモデルを取得 で model_type=text-embedding を指定した際の provider フィールドの値を使用します。
検索モデルの設定です。このナレッジベースをクエリする際のチャンクの検索方法とランキング方法を制御します。
Show child attributes
Show child attributes
permission が partial_members の場合にアクセス権を持つチームメンバーのリストです。
Show child attributes
Show child attributes
外部ナレッジベースの検索設定です。
Show child attributes
Show child attributes
外部ナレッジベースの ID です。
外部ナレッジ API 接続の ID です。
Response
ナレッジベースが正常に更新されました。
ナレッジベースの一意識別子です。
ナレッジベースの表示名です。ワークスペース内で一意です。
ナレッジベースの目的または内容を説明するオプションのテキストです。
プロバイダータイプです。内部管理の場合は vendor、外部ナレッジベース接続の場合は external です。
このナレッジベースにアクセスできるユーザーを制御します。指定可能な値:only_me、all_team_members、partial_members。
ドキュメントのデータソースタイプです。まだ設定されていない場合は null です。
high_quality は埋め込みモデルを使用した精密検索、economy はキーワードベースのインデキシングです。
現在このナレッジベースを使用しているアプリケーションの数です。
ナレッジベース内のドキュメント総数です。
全ドキュメントの合計単語数です。
ナレッジベースを作成したユーザーの ID です。
作成者の表示名です。
作成タイムスタンプ(Unix エポック、秒単位)です。
ナレッジベースを最後に更新したユーザーの ID です。
最終更新タイムスタンプ(Unix エポック、秒単位)です。
インデックス作成に使用される埋め込みモデルの名前です。
埋め込みモデルプロバイダーです。利用可能なモデルを取得 で model_type=text-embedding を指定した際の provider フィールドの値を使用します。
設定された埋め込みモデルが現在利用可能かどうかです。
ナレッジベースの検索設定です。
Show child attributes
Show child attributes
サマリーインデックスの設定です。
Show child attributes
Show child attributes
このナレッジベースに関連付けられたタグです。
Show child attributes
Show child attributes
ドキュメントのチャンキングモードです。text_model は標準テキストチャンキング、hierarchical_model は親子構造、qa_model は QA ペア抽出を示します。
外部ナレッジベースの接続詳細です。provider が external の場合に存在します。
Show child attributes
Show child attributes
外部ナレッジベースの検索設定です。内部ナレッジベースの場合は null です。
Show child attributes
Show child attributes
ナレッジベースのメタデータフィールド定義です。
Show child attributes
Show child attributes
組み込みメタデータフィールド(例:document_name、uploader)が有効かどうかです。
カスタム処理パイプラインが設定されている場合のパイプライン ID です。
ランタイム処理モードです。
チャンク構造の設定です。
ナレッジベースのアイコン表示設定です。
Show child attributes
Show child attributes
ナレッジベースが公開済みかどうかです。
ドキュメントの合計数です。
有効で利用可能なドキュメントの数です。
このナレッジベースで API アクセスが有効かどうかです。
マルチモーダルコンテンツ処理が有効かどうかです。
ナレッジベースのメンテナーの表示名です。設定されていない場合は null です。
permission が partial_members の場合にアクセスを許可されたメンバーのアカウント ID です。更新レスポンスでは常に含まれ、詳細レスポンスでは permission が partial_members の場合にのみ含まれます。
Was this page helpful?
curl --request PATCH \
--url https://{api_base_url}/datasets/{dataset_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"embedding_model": "<string>",
"embedding_model_provider": "<string>",
"partial_member_list": [
{
"user_id": "<string>"
}
],
"external_retrieval_model": {
"top_k": 123,
"score_threshold": 123,
"score_threshold_enabled": true
},
"external_knowledge_id": "<string>",
"external_knowledge_api_id": "<string>"
}
'import requests
url = "https://{api_base_url}/datasets/{dataset_id}"
payload = {
"name": "<string>",
"description": "<string>",
"embedding_model": "<string>",
"embedding_model_provider": "<string>",
"partial_member_list": [{ "user_id": "<string>" }],
"external_retrieval_model": {
"top_k": 123,
"score_threshold": 123,
"score_threshold_enabled": True
},
"external_knowledge_id": "<string>",
"external_knowledge_api_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
embedding_model: '<string>',
embedding_model_provider: '<string>',
partial_member_list: [{user_id: '<string>'}],
external_retrieval_model: {top_k: 123, score_threshold: 123, score_threshold_enabled: true},
external_knowledge_id: '<string>',
external_knowledge_api_id: '<string>'
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'embedding_model' => '<string>',
'embedding_model_provider' => '<string>',
'partial_member_list' => [
[
'user_id' => '<string>'
]
],
'external_retrieval_model' => [
'top_k' => 123,
'score_threshold' => 123,
'score_threshold_enabled' => true
],
'external_knowledge_id' => '<string>',
'external_knowledge_api_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{api_base_url}/datasets/{dataset_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"embedding_model\": \"<string>\",\n \"embedding_model_provider\": \"<string>\",\n \"partial_member_list\": [\n {\n \"user_id\": \"<string>\"\n }\n ],\n \"external_retrieval_model\": {\n \"top_k\": 123,\n \"score_threshold\": 123,\n \"score_threshold_enabled\": true\n },\n \"external_knowledge_id\": \"<string>\",\n \"external_knowledge_api_id\": \"<string>\"\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))
}HttpResponse<String> response = Unirest.patch("https://{api_base_url}/datasets/{dataset_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"embedding_model\": \"<string>\",\n \"embedding_model_provider\": \"<string>\",\n \"partial_member_list\": [\n {\n \"user_id\": \"<string>\"\n }\n ],\n \"external_retrieval_model\": {\n \"top_k\": 123,\n \"score_threshold\": 123,\n \"score_threshold_enabled\": true\n },\n \"external_knowledge_id\": \"<string>\",\n \"external_knowledge_api_id\": \"<string>\"\n}")
.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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"embedding_model\": \"<string>\",\n \"embedding_model_provider\": \"<string>\",\n \"partial_member_list\": [\n {\n \"user_id\": \"<string>\"\n }\n ],\n \"external_retrieval_model\": {\n \"top_k\": 123,\n \"score_threshold\": 123,\n \"score_threshold_enabled\": true\n },\n \"external_knowledge_id\": \"<string>\",\n \"external_knowledge_api_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body