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

アノテーション返信機能を有効または無効にします。有効にする場合は埋め込みモデルの設定が必要です。非同期で実行されます——アノテーション返信の初期設定タスクステータスを取得 で進捗を追跡します。

POST /apps/annotation-reply/{action}

Error

A valid request URL is required to generate request examples

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 の漏洩は深刻な結果につながる可能性があります。

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

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

Required range: 0 <= x <= 1

Response

200 - application/json

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

job_id · string<uuid>

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

job_status · string

現在のジョブステータスです。waiting はキュー待ち、processing は処理中、completed は完了、error は失敗を示します。