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

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

アノテーション返信機能を有効または無効にします。リクエストボディはアクションの実行前に検証されるため、enable と disable のどちらでも embedding_provider_name、embedding_model_name、score_threshold が必須です。非同期で実行されます。進捗は アノテーション返信の初期設定タスクステータスを取得 で追跡してください。

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

200

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

Authorizations

Authorization · string · header · required

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

Path Parameters

action · enum<string> · required

実行するアクションです。

Available options: enable, disable

Body

application/json

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

embedding_provider_name · string · required

埋め込みモデルプロバイダーの名前（例：openai、cohere）です。

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 は アノテーション返信の初期設定タスクステータスを取得 からのみ返されます。