メインコンテンツへスキップ
POST
アノテーション返信を設定

承認

Authorization
string
header
必須

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

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

パスパラメータ

action
enum<string>
必須

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

利用可能なオプション:
enable,
disable

ボディ

application/json

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

embedding_provider_name
string
必須

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

embedding_model_name
string
必須

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

score_threshold
number<float>
必須

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

レスポンス

200 - application/json

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

job_id
string<uuid>

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

job_status
string

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