アノテーション返信を設定

対象アプリ：Chatflow、チャットボット、Agent。

アプリのアノテーション返信を有効または無効にします。非同期で実行されます。進捗は アノテーション返信の初期設定タスクステータスを取得 で追跡してください。

リクエストボディはアクションの実行前に検証されるため、disable の場合でも score_threshold、embedding_provider_name、embedding_model_name が必須です。

POST /apps/annotation-reply/{action}

アノテーション返信を設定

cURL

curl --request POST \
  --url https://{api_base_url}/apps/annotation-reply/{action} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "score_threshold": 0.9,
  "embedding_provider_name": "openai",
  "embedding_model_name": "text-embedding-3-small"
}
'

import requests

url = "https://{api_base_url}/apps/annotation-reply/{action}"

payload = {
    "score_threshold": 0.9,
    "embedding_provider_name": "openai",
    "embedding_model_name": "text-embedding-3-small"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    score_threshold: 0.9,
    embedding_provider_name: 'openai',
    embedding_model_name: 'text-embedding-3-small'
  })
};

fetch('https://{api_base_url}/apps/annotation-reply/{action}', 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}/apps/annotation-reply/{action}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'score_threshold' => 0.9,
    'embedding_provider_name' => 'openai',
    'embedding_model_name' => 'text-embedding-3-small'
  ]),
  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}/apps/annotation-reply/{action}"

	payload := strings.NewReader("{\n  \"score_threshold\": 0.9,\n  \"embedding_provider_name\": \"openai\",\n  \"embedding_model_name\": \"text-embedding-3-small\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://{api_base_url}/apps/annotation-reply/{action}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"score_threshold\": 0.9,\n  \"embedding_provider_name\": \"openai\",\n  \"embedding_model_name\": \"text-embedding-3-small\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/apps/annotation-reply/{action}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"score_threshold\": 0.9,\n  \"embedding_provider_name\": \"openai\",\n  \"embedding_model_name\": \"text-embedding-3-small\"\n}"

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

200

{
  "job_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "job_status": "waiting"
}

Authorizations

Authorization · string · header · required

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

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

Path Parameters

action · enum<string> · required

アノテーション返信を有効にするか無効にするかを指定します。

Available options: enable, disable

Body

application/json

アノテーション返信設定を構成するためのリクエストボディです。

embedding_provider_name · string · required

埋め込みモデルプロバイダーです（例：openai）。利用可能なプロバイダーは 利用可能なモデルを取得 から取得します。

embedding_model_name · string · required

マッチングのためにアノテーションをベクトル化する埋め込みモデルです（例：text-embedding-3-small）。

score_threshold · number<float> · required

アノテーションがマッチとみなされるための最低類似度スコアです。値が高いほど、より正確なマッチが必要になります。

Response

200 - application/json

アノテーション返信設定タスクが開始されました。

job_id · string<uuid>

非同期ジョブ ID です。アノテーション返信の初期設定タスクステータスを取得 と組み合わせて進捗を追跡します。

job_status · string

現在のジョブステータスです。このエンドポイントが返すのは waiting（キュー待ち）または processing（処理中）のみです。completed と error は アノテーション返信の初期設定タスクステータスを取得 からのみ返されます。