> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

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

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



## OpenAPI

````yaml /ja/api-reference/openapi_chatflow.json post /apps/annotation-reply/{action}
openapi: 3.0.1
info:
  title: 高度なチャットアプリAPI (Chatflow API)
  description: >-
    Chatflow アプリケーションはセッションの永続化をサポートし、過去のチャット履歴をレスポンスのコンテキストとして使用できます。Chatflow
    アプリは `advanced-chat`
    モードを使用し、ノードの開始・完了、イテレーション、ワークフローのライフサイクルを含む詳細な実行追跡のためのワークフローレベルのストリーミングイベントを提供します。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: Chatflow アプリ API のベース URL です。セルフホスト環境では、独自の API ベース URL に置き換えてください。
    variables:
      api_base_url:
        default: api.dify.ai/v1
        description: API ベース URL のホストとパス（`https://` を除く）。
security:
  - ApiKeyAuth: []
tags:
  - name: チャットフロー
    description: チャットフローアプリケーションの操作です（チャットメッセージ、ワークフロー実行詳細、イベントストリーミングを含む）。
  - name: ファイル操作
    description: ファイルのアップロードとプレビューの操作です。
  - name: エンドユーザー
    description: エンドユーザー情報に関連する操作です。
  - name: メッセージフィードバック
    description: ユーザーフィードバックの操作です。
  - name: 会話管理
    description: 会話管理に関連する操作です。
  - name: 音声・テキスト変換
    description: テキスト読み上げと音声認識の操作です。
  - name: アプリケーション設定
    description: アプリケーション設定と情報を取得する操作です。
  - name: アノテーション管理
    description: ダイレクト返信用のアノテーション管理に関連する操作です。
  - name: 人間の入力
    description: 人間の入力を要する一時停止中のワークフローの再開操作です。
paths:
  /apps/annotation-reply/{action}:
    post:
      tags:
        - アノテーション管理
      summary: アノテーション返信を設定
      description: >-
        アノテーション返信機能を有効または無効にします。有効にする場合は埋め込みモデルの設定が必要です。非同期で実行されます——[アノテーション返信の初期設定タスクステータスを取得](/api-reference/アノテーション管理/アノテーション返信の初期設定タスクステータスを取得)
        で進捗を追跡します。
      operationId: setChatflowAnnotationReplyJa
      parameters:
        - name: action
          in: path
          required: true
          description: 実行するアクションです。
          schema:
            type: string
            enum:
              - enable
              - disable
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitialAnnotationReplySettingsRequest'
            examples:
              enableAnnotationReply:
                summary: リクエスト例
                value:
                  score_threshold: 0.9
                  embedding_provider_name: openai
                  embedding_model_name: text-embedding-3-small
      responses:
        '200':
          description: アノテーション返信設定タスクが開始されました。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitialAnnotationReplySettingsResponse'
              examples:
                annotationReplyResponse:
                  summary: レスポンス例
                  value:
                    job_id: a1b2c3d4-5678-90ab-cdef-1234567890ab
                    job_status: waiting
components:
  schemas:
    InitialAnnotationReplySettingsRequest:
      type: object
      description: アノテーション返信設定を構成するためのリクエストボディです。
      required:
        - score_threshold
        - embedding_provider_name
        - embedding_model_name
      properties:
        embedding_provider_name:
          type: string
          description: 埋め込みモデルプロバイダーの名前（例：`openai`、`cohere`）です。
        embedding_model_name:
          type: string
          description: アノテーションマッチングに使用する埋め込みモデルの名前です（例：`text-embedding-3-small`）。
        score_threshold:
          type: number
          format: float
          description: アノテーションがマッチとみなされるための最低類似度スコアです。値が高いほど、より正確なマッチが必要になります。
          minimum: 0
          maximum: 1
    InitialAnnotationReplySettingsResponse:
      type: object
      properties:
        job_id:
          type: string
          format: uuid
          description: >-
            非同期ジョブ ID
            です。[アノテーション返信の初期設定タスクステータスを取得](/api-reference/アノテーション管理/アノテーション返信の初期設定タスクステータスを取得)
            と組み合わせて進捗を追跡します。
        job_status:
          type: string
          description: >-
            現在のジョブステータスです。`waiting` はキュー待ち、`processing` は処理中、`completed`
            は完了、`error` は失敗を示します。
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        API Key 認証です。すべての API リクエストにおいて、`Authorization` HTTP ヘッダーに `Bearer `
        プレフィックスを付けた API Key を含めてください。例：`Authorization: Bearer {API_KEY}`。**API
        Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key
        の漏洩は深刻な結果につながる可能性があります。**

````