メインコンテンツへスキップ
PATCH
/
datasets
/
tags
ナレッジベースタグを変更
curl --request PATCH \
  --url https://{api_base_url}/datasets/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tag_id": "<string>",
  "name": "<string>"
}
'
import requests

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

payload = {
    "tag_id": "<string>",
    "name": "<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({tag_id: '<string>', name: '<string>'})
};

fetch('https://{api_base_url}/datasets/tags', 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/tags",
  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([
    'tag_id' => '<string>',
    'name' => '<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/tags"

	payload := strings.NewReader("{\n  \"tag_id\": \"<string>\",\n  \"name\": \"<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/tags")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tag_id\": \"<string>\",\n  \"name\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"tag_id\": \"<string>\",\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "f4b5c6d7-e8f9-0a1b-2c3d-4e5f6a7b8c9d",
  "name": "Product Docs",
  "type": "knowledge",
  "binding_count": "0"
}

承認

Authorization
string
header
必須

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

ボディ

application/json
tag_id
string
必須

更新するタグ ID です。

name
string
必須

新しいタグ名です。

Required string length: 1 - 50

レスポンス

200 - application/json

タグが正常に更新されました。

id
string

タグ識別子です。

name
string

タグの表示名です。

type
string

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

binding_count
string | null

このタグにバインドされたナレッジベースの数です。