> ## Documentation Index
> Fetch the complete documentation index at: https://adp-doc.laiye.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 智能体生成抽取字段提示词

> 基于示例文档或提示词，AI 自动生成字段名称、字段类型和字段提示词等配置参考。传入高速版自定义抽取应用的 app_id 时，会进入高速版自动生成配置服务，返回 common_rule、field_rule、table_rule 等配置预览；该接口不会保存配置版本，也不会自动回填到 Web 页面应用中。高速版应用必须提供 file_url 或 file_base64，prompt 仅作为辅助生成提示。



## OpenAPI

````yaml /api-reference/adp-api.yaml post /open/agentic_doc_processor/{tenant_name}/v1/app-manage/ai-recommend
openapi: 3.1.0
info:
  title: ADP API
  version: 1.0.0
  description: Laiye ADP 官方 OpenAPI 接口规范，覆盖文档抽取、文档解析、抽取应用管理、积分查询、工作流运行和工作流文件管理。
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://adp.laiye.com
    description: ADP 生产环境
security: []
tags:
  - name: 文档抽取
    description: 从上传的文档中抽取结构化字段。
  - name: 文档解析
    description: 识别上传文档中的文字、版面块和位置信息。
  - name: 应用管理
    description: 创建、修改、删除和查询抽取应用及配置。
  - name: 账户
    description: 查询账户积分和使用情况。
  - name: 工作流
    description: 运行工作流应用并查询执行结果。
  - name: 工作流文件
    description: 上传和管理工作流应用使用的文件。
paths:
  /open/agentic_doc_processor/{tenant_name}/v1/app-manage/ai-recommend:
    post:
      tags:
        - 应用管理
      summary: 智能体生成抽取字段提示词
      description: >-
        基于示例文档或提示词，AI 自动生成字段名称、字段类型和字段提示词等配置参考。传入高速版自定义抽取应用的 app_id
        时，会进入高速版自动生成配置服务，返回 common_rule、field_rule、table_rule
        等配置预览；该接口不会保存配置版本，也不会自动回填到 Web 页面应用中。高速版应用必须提供 file_url 或
        file_base64，prompt 仅作为辅助生成提示。
      operationId: recommendExtractionFields
      parameters:
        - $ref: '#/components/parameters/TenantName'
      requestBody:
        $ref: '#/components/requestBodies/AiRecommendRequest'
      responses:
        '200':
          $ref: '#/components/responses/AiRecommendResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    TenantName:
      name: tenant_name
      in: path
      required: true
      description: 租户名称，默认 laiye。
      schema:
        type: string
        default: laiye
  requestBodies:
    AiRecommendRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AiRecommendRequest'
          examples:
            standardCustomExtractionApp:
              summary: 标准版自定义抽取应用生成字段提示词
              value:
                app_id: app_1406
                file_url: >-
                  https://adp.laiye.com/web/agentic_doc_processor/laiye/file/2003c711818811f1a36200163e358400
                prompt: 请从发票中抽取发票号码、开票日期和价税合计。
            highSpeedCustomExtractionApp:
              summary: 高速版自定义抽取应用自动生成配置预览
              value:
                app_id: app_1425
                file_url: >-
                  https://adp.laiye.com/web/agentic_doc_processor/laiye/file/2003c711818811f1a36200163e358400
                prompt: 请根据票据版面生成字段配置，字段 key 使用英文下划线命名。
  responses:
    AiRecommendResponse:
      description: 智能体生成字段配置结果。高速版返回配置预览，不会保存配置版本。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AiRecommendResponse'
          examples:
            standardCustomExtractionApp:
              summary: 标准版自定义抽取应用推荐字段
              value:
                code: success
                message: ''
                tips: null
                data:
                  app_id: app_1406
                  app_name: ''
                  extract_fields:
                    - field_name: 发票号码
                      field_type: string
                      field_prompt: 抽取税务发票的唯一标识编号。
                    - field_name: 开票日期
                      field_type: date
                      field_prompt: 抽取发票开具日期。
            highSpeedCustomExtractionApp:
              summary: 高速版自定义抽取应用自动生成配置预览
              value:
                code: success
                message: ''
                tips: null
                data:
                  app_id: app_1425
                  app_name: 高速版发票抽取应用
                  ai_function: 1425
                  extract_fields:
                    - field_key: invoice_number
                      field_name: 发票号码
                      field_type: string
                      field_prompt: 税务发票的唯一标识编号。
                      field_description: 税务发票的唯一标识编号。
                    - field_key: invoice_date
                      field_name: 开票日期
                      field_type: date
                      field_prompt: 发票开具日期。
                      field_description: 发票开具日期。
                  prompt_rule: 仅抽取票面中明确出现的字段。
                  common_rule: 仅抽取票面中明确出现的字段。
                  field_rule:
                    - field_key: invoice_number
                      field_name: 发票号码
                      field_type: string
                      field_description: 税务发票的唯一标识编号。
                    - field_key: invoice_date
                      field_name: 开票日期
                      field_type: date
                      field_description: 发票开具日期。
                  table_rule:
                    - field_key: line_items
                      field_name: 明细
                      field_type: table
                      field_description: 发票明细表。
                      field_parent_id: ''
                    - field_key: item_name
                      field_name: 商品名称
                      field_type: string
                      field_description: 明细中的商品或服务名称。
                      field_parent_id: line_items
                    - field_key: item_amount
                      field_name: 金额
                      field_type: string
                      field_description: 明细金额。
                      field_parent_id: line_items
                  page_count: 2
                  document_type: invoice
    ValidationError:
      description: 参数校验错误。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SimpleResponse'
  schemas:
    AiRecommendRequest:
      type: object
      additionalProperties: false
      description: 智能体生成字段配置请求。请求体需提供 file_url 或 file_base64；prompt 可作为辅助生成提示。
      properties:
        app_id:
          type: string
          description: 应用 ID。传入高速版自定义抽取应用时，返回高速版自动生成配置预览。
        file_base64:
          type: string
          description: 文件 Base64 编码。高速版应用与 file_url 二选一必填。
        file_url:
          type: string
          format: uri
          description: 文件 URL。高速版应用与 file_base64 二选一必填。
        prompt:
          type: string
          description: 用户提供的生成提示。需要同时提供文件，并将 prompt 作为辅助说明。
        doc_type:
          type: string
          description: 文档类型。标准版自动生成建议时可传入；高速版会根据文档自动识别。
        doc_type_description:
          type: string
          description: 文档类型描述。标准版自动生成建议时可传入。
      required:
        - app_id
      anyOf:
        - required:
            - file_base64
        - required:
            - file_url
    AiRecommendResponse:
      allOf:
        - $ref: '#/components/schemas/SimpleResponse'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/AiRecommendData'
    SimpleResponse:
      type: object
      properties:
        code:
          oneOf:
            - type: string
            - type: integer
          description: 业务码。成功通常为 success 或 200。
        message:
          type: string
          description: 返回信息。
        tips:
          type:
            - string
            - 'null'
          description: 详细信息，默认为空。
    AiRecommendData:
      type: object
      additionalProperties: true
      properties:
        app_id:
          type: string
          description: 应用 ID。
        app_name:
          type: string
          description: 应用名称。
        ai_function:
          type: integer
          enum:
            - 1406
            - 1425
          description: 应用类型。1406 表示标准版自定义抽取；1425 表示高速版自定义抽取。
        extract_fields:
          type: array
          description: 兼容字段列表。标准版返回推荐字段；高速版当前返回普通字段预览，完整配置请使用 field_rule 和 table_rule。
          items:
            $ref: '#/components/schemas/AiRecommendFieldConfig'
        prompt_rule:
          type: string
          description: 高速版自动生成配置的整体规则，兼容字段。
        common_rule:
          type: string
          description: 高速版自动生成配置的整体规则。
        field_rule:
          type: array
          description: 高速版自动生成的普通字段配置预览。该字段不会自动保存到应用配置中。
          items:
            $ref: '#/components/schemas/AiRecommendGeneratedRuleField'
        table_rule:
          type: array
          description: >-
            高速版自动生成的表格字段配置预览，采用平铺结构。field_parent_id 为空的记录为表格父字段，field_parent_id
            指向父字段 field_key 的记录为表格子字段。
          items:
            $ref: '#/components/schemas/AiRecommendGeneratedRuleField'
        page_count:
          type: integer
          description: 高速版自动生成配置时使用的页数。
        document_type:
          type: string
          description: 高速版自动识别的文档类型。
    AiRecommendFieldConfig:
      type: object
      additionalProperties: true
      properties:
        field_key:
          type: string
          description: 字段唯一标识。高速版自动生成配置时返回。
        field_name:
          type: string
          description: 字段名称。
        field_type:
          type: string
          enum:
            - string
            - date
            - table
          description: 字段类型。
        field_prompt:
          type:
            - string
            - 'null'
          description: 字段提示词。
        field_description:
          type:
            - string
            - 'null'
          description: 字段描述。
        sub_fields:
          type: array
          description: 表格子字段列表。标准版表格字段可能返回该字段；高速版表格字段请查看 table_rule。
          items:
            $ref: '#/components/schemas/AiRecommendSubFieldConfig'
      required:
        - field_name
        - field_type
    AiRecommendGeneratedRuleField:
      type: object
      additionalProperties: true
      properties:
        field_key:
          type: string
          description: 字段唯一标识。表格子字段的 field_parent_id 会引用表格父字段的 field_key。
        field_name:
          type: string
          description: 字段名称。
        field_type:
          type: string
          enum:
            - string
            - date
            - table
          description: 字段类型。table 表示表格父字段。
        field_description:
          type: string
          description: 字段描述。
        field_parent_id:
          type: string
          description: 表格子字段所属的父字段 field_key。为空时表示普通字段或表格父字段。
        config:
          type: object
          additionalProperties: true
          description: 字段扩展配置。
        source:
          type: integer
          description: 字段来源。
        _field_key_source:
          type: string
          description: 模型生成的原始字段 key，仅在服务保留调试信息时返回。
    AiRecommendSubFieldConfig:
      type: object
      additionalProperties: true
      properties:
        field_key:
          type: string
          description: 子字段唯一标识。
        field_name:
          type: string
          description: 子字段名称。
        field_type:
          type: string
          enum:
            - string
            - date
          description: 子字段类型。
        field_prompt:
          type:
            - string
            - 'null'
          description: 子字段提示词。
        field_description:
          type:
            - string
            - 'null'
          description: 子字段描述。
      required:
        - field_name
        - field_type
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        生产环境的用户 OpenAPI Accessor access_key，在 ADP 平台的「我的 API」中查看。key
        被禁用、过期或不属于生产环境时会返回 Accessor not found。

````