アノテーション返信を設定
対象アプリ:Chatflow、チャットボット、Agent。
アプリのアノテーション返信を有効または無効にします。非同期で実行されます。進捗は アノテーション返信の初期設定タスクステータスを取得 で追跡してください。
リクエストボディはアクションの実行前に検証されるため、disable の場合でも score_threshold、embedding_provider_name、embedding_model_name が必須です。
承認
すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。
パスパラメータ
アノテーション返信を有効にするか無効にするかを指定します。
enable, disable ボディ
アノテーション返信設定を構成するためのリクエストボディです。
埋め込みモデルプロバイダーです(例:openai)。利用可能なプロバイダーは 利用可能なモデルを取得 から取得します。
マッチングのためにアノテーションをベクトル化する埋め込みモデルです(例:text-embedding-3-small)。
アノテーションがマッチとみなされるための最低類似度スコアです。値が高いほど、より正確なマッチが必要になります。
レスポンス
アノテーション返信設定タスクが開始されました。
非同期ジョブ ID です。アノテーション返信の初期設定タスクステータスを取得 と組み合わせて進捗を追跡します。
現在のジョブステータスです。このエンドポイントが返すのは waiting(キュー待ち)または processing(処理中)のみです。completed と error は アノテーション返信の初期設定タスクステータスを取得 からのみ返されます。