> ## 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.

# 配置标注回复

> **适用于**：Chatflow、聊天助手、Agent。

启用或禁用标注回复功能。请求体在执行操作前校验，因此无论 `enable` 还是 `disable` 都必须提供 `embedding_provider_name`、`embedding_model_name` 和 `score_threshold`。异步执行，使用 [查询标注回复配置任务状态](/zh/api-reference/annotations/get-annotation-reply-job-status) 跟踪进度。



## OpenAPI

````yaml /zh/api-reference/openapi_service.json post /apps/annotation-reply/{action}
openapi: 3.0.1
info:
  title: Dify 服务 API
  description: 用于 Dify 应用与知识库的 REST API。应用类接口使用应用 API 密钥认证，知识库类接口使用知识库 API 密钥认证。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: Dify 服务 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: 暂停等待人工输入的工作流恢复操作。
  - 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: >-
        **适用于**：Chatflow、聊天助手、Agent。


        启用或禁用标注回复功能。请求体在执行操作前校验，因此无论 `enable` 还是 `disable` 都必须提供
        `embedding_provider_name`、`embedding_model_name` 和
        `score_threshold`。异步执行，使用
        [查询标注回复配置任务状态](/zh/api-reference/annotations/get-annotation-reply-job-status)
        跟踪进度。
      operationId: setChatAnnotationReplyZh
      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: 标注被视为匹配的最低相似度分数。值越高，要求匹配越精确。
    InitialAnnotationReplySettingsResponse:
      type: object
      properties:
        job_id:
          type: string
          format: uuid
          description: >-
            异步任务 ID。配合
            [查询标注回复配置任务状态](/zh/api-reference/annotations/get-annotation-reply-job-status)
            使用以跟踪进度。
        job_status:
          type: string
          description: >-
            当前任务状态，仅为 `waiting`（排队中）或 `processing`（处理中）；`completed` 和 `error` 仅由
            [查询标注回复配置任务状态](/zh/api-reference/annotations/get-annotation-reply-job-status)
            返回。
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        API Key 认证。对于所有 API 请求，请在 `Authorization` HTTP 头中包含您的 API Key，并加上
        `Bearer ` 前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将 API Key
        存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。**缺少或无效的 API Key 会返回 HTTP
        `401`，错误码为 `unauthorized`。

````