StartAwsTextractJob Processor

类型全限定名：cn.org.acal.lynxus.processors.aws.ml.textract.StartAwsTextractJob

所属 Bundle：cn.org.acal.lynxus:lynxus-aws-nar:2.11.8

描述

触发 AWS Textract 作业。它后面应该是 GetAwsTextractJobStatus 处理器，以便监控作业状态。

属性

下表中，加粗的属性为必填项；其余为可选项。表格同时标注默认值、是否支持表达式语言，以及是否为敏感属性（值会被加密）。

名称	默认值	可选值	描述
AWS Credentials Provider Service		控制器服务 API： `AwsCredentialsProviderService` cn.org.acal.lynxus-lynxus-aws-service-api-nar-2.11.8	用于获取AWS凭证提供者的Controller Service
Region	`us-west-2`	Africa (Cape Town) — AWS Region Code : af-south-1 Asia Pacific (Hong Kong) — AWS Region Code : ap-east-1 Asia Pacific (Hyderabad) — AWS Region Code : ap-south-2 Asia Pacific (Jakarta) — AWS Region Code : ap-southeast-3 Asia Pacific (Malaysia) — AWS Region Code : ap-southeast-5 Asia Pacific (Melbourne) — AWS Region Code : ap-southeast-4 Asia Pacific (Mumbai) — AWS Region Code : ap-south-1 Asia Pacific (New Zealand) — AWS Region Code : ap-southeast-6 Asia Pacific (Osaka) — AWS Region Code : ap-northeast-3 Asia Pacific (Seoul) — AWS Region Code : ap-northeast-2 Asia Pacific (Singapore) — AWS Region Code : ap-southeast-1 Asia Pacific (Sydney) — AWS Region Code : ap-southeast-2 Asia Pacific (Taipei) — AWS Region Code : ap-east-2 Asia Pacific (Thailand) — AWS Region Code : ap-southeast-7 Asia Pacific (Tokyo) — AWS Region Code : ap-northeast-1 AWS European Sovereign Cloud (Germany) — AWS Region Code : eusc-de-east-1 aws global region — AWS Region Code : aws-global AWS GovCloud (US-East) — AWS Region Code : us-gov-east-1 AWS GovCloud (US-West) — AWS Region Code : us-gov-west-1 aws-cn global region — AWS Region Code : aws-cn-global aws-iso global region — AWS Region Code : aws-iso-global aws-iso-b global region — AWS Region Code : aws-iso-b-global aws-iso-e global region — AWS Region Code : aws-iso-e-global aws-iso-f global region — AWS Region Code : aws-iso-f-global aws-us-gov global region — AWS Region Code : aws-us-gov-global Canada (Central) — AWS Region Code : ca-central-1 Canada West (Calgary) — AWS Region Code : ca-west-1 China (Beijing) — AWS Region Code : cn-north-1 China (Ningxia) — AWS Region Code : cn-northwest-1 EU ISOE West — AWS Region Code : eu-isoe-west-1 Europe (Frankfurt) — AWS Region Code : eu-central-1 Europe (Ireland) — AWS Region Code : eu-west-1 Europe (London) — AWS Region Code : eu-west-2 Europe (Milan) — AWS Region Code : eu-south-1 Europe (Paris) — AWS Region Code : eu-west-3 Europe (Spain) — AWS Region Code : eu-south-2 Europe (Stockholm) — AWS Region Code : eu-north-1 Europe (Zurich) — AWS Region Code : eu-central-2 Israel (Tel Aviv) — AWS Region Code : il-central-1 Mexico (Central) — AWS Region Code : mx-central-1 Middle East (Bahrain) — AWS Region Code : me-south-1 Middle East (UAE) — AWS Region Code : me-central-1 South America (Sao Paulo) — AWS Region Code : sa-east-1 US East (N. Virginia) — AWS Region Code : us-east-1 US East (Ohio) — AWS Region Code : us-east-2 US ISO East — AWS Region Code : us-iso-east-1 US ISO WEST — AWS Region Code : us-iso-west-1 US ISOB East (Ohio) — AWS Region Code : us-isob-east-1 US ISOB West — AWS Region Code : us-isob-west-1 US ISOF EAST — AWS Region Code : us-isof-east-1 US ISOF SOUTH — AWS Region Code : us-isof-south-1 US West (N. California) — AWS Region Code : us-west-1 US West (Oregon) — AWS Region Code : us-west-2 Use Custom Region — 用户定义的区域，可以是非 AWS 区域，和/或来自表达式语言（Expression Language）	服务所在的 AWS 区域
Custom Region			自定义区域，例如 AWS 兼容服务提供商的区域支持表达式语言：是（仅使用环境/系统变量求值）
Communications Timeout	`30 secs`
JSON Payload			AWS 机器学习服务的 JSON 请求。当未指定此属性时，处理器将使用 FlowFile 内容进行请求。支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
SSL Context Service		控制器服务 API： `SSLContextProvider` cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8	指定可选的 SSL 上下文服务，如果提供，将用于创建连接
Endpoint Override URL			用于替代 AWS 默认端点的端点 URL，包括协议、主机、端口和路径。AWS 库根据 AWS 区域选择端点 URL，但此属性会覆盖所选端点 URL，允许与其他 S3 兼容端点一起使用。支持表达式语言：是（仅使用环境/系统变量求值）
Textract Type	`Document Analysis`	Expense Analysis Document Analysis Document Text Detection	支持的值：\"Document Analysis\"、\"Document Text Detection\"、\"Expense Analysis\"

关系 (Relationships)

名称	描述	自动终止
`failure`	FlowFiles被路由到故障关系	否
`original`	成功完成后，原始 FlowFile 将被路由到此关系。	是
`success`	FlowFiles被路由到成功关系	否

写入的 FlowFile 属性

名称	描述
`awsTaskId`	可用于在 GetAwsTextractJobStatus 中轮询作业完成情况的任务 ID
`awsTextractType`	选定的 Textract 类型，可在 GetAwsTextractJobStatus 中使用

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

另请参阅

GetAwsTextractJobStatus

详细说明

Amazon Textract

StartAwsTextractJob

Amazon Textract 是一项机器学习（ML）服务，可以自动从扫描文档中提取文本、手写内容和数据。它超越了简单的光学字符识别（OCR），能够识别、理解并从表单和表格中提取数据。

用法

Amazon ML Processors 基于官方 AWS API 参考实现，以使用 ML 服务。可以在文档的 Request Syntax 小节找到 JSON 负载示例。更多细节请查阅官方 Textract API 参考。使用该 Processor 会根据你配置的 textract 类型，触发 startDocumentAnalysis、startDocumentTextDetection 或 startExpenseAnalysis 异步调用。可以把 JSON 负载定义为属性，或作为 FlowFile 内容提供，属性的优先级更高。任务触发后，序列化的 JSON 响应会写入输出 FlowFile。awsTaskId Attribute 会被填充，便于用对应的 get job status Processor 查询任务状态。

支持三种不同类型的 textract 任务：文档分析（Document Analysis）、文本检测（Text Detection）、费用分析（Expense Analysis）。

DocumentAnalysis

启动对输入文档的异步分析，检测键值对、表格和选择元素等检测项之间的关系。API 参考

示例负载：

{
  "ClientRequestToken": "string",
  "DocumentLocation": {
    "S3Object": {
      "Bucket": "string",
      "Name": "string",
      "Version": "string"
    }
  },
  "FeatureTypes": [
    "string"
  ],
  "JobTag": "string",
  "KMSKeyId": "string",
  "NotificationChannel": {
    "RoleArn": "string",
    "SNSTopicArn": "string"
  },
  "OutputConfig": {
    "S3Bucket": "string",
    "S3Prefix": "string"
  },
  "QueriesConfig": {
    "Queries": [
      {
        "Alias": "string",
        "Pages": [
          "string"
        ],
        "Text": "string"
      }
    ]
  }
}

ExpenseAnalysis

启动对发票或收据的异步分析，提取联系信息、购买项目、供应商名称等数据。API 参考

示例负载：

{
  "ClientRequestToken": "string",
  "DocumentLocation": {
    "S3Object": {
      "Bucket": "string",
      "Name": "string",
      "Version": "string"
    }
  },
  "JobTag": "string",
  "KMSKeyId": "string",
  "NotificationChannel": {
    "RoleArn": "string",
    "SNSTopicArn": "string"
  },
  "OutputConfig": {
    "S3Bucket": "string",
    "S3Prefix": "string"
  }
}

StartDocumentTextDetection

启动对文档中文本的异步检测。Amazon Textract 可以检测文本行以及构成文本行的单词。API 参考

示例负载：

{
  "ClientRequestToken": "string",
  "DocumentLocation": {
    "S3Object": {
      "Bucket": "string",
      "Name": "string",
      "Version": "string"
    }
  },
  "JobTag": "string",
  "KMSKeyId": "string",
  "NotificationChannel": {
    "RoleArn": "string",
    "SNSTopicArn": "string"
  },
  "OutputConfig": {
    "S3Bucket": "string",
    "S3Prefix": "string"
  }
}

StartAwsTextractJob

StartAwsTextractJob Processor

描述

标签

属性

关系 (Relationships)

写入的 FlowFile 属性

状态管理

受限 (Restricted)

另请参阅

详细说明

Amazon Textract

StartAwsTextractJob

用法

DocumentAnalysis

ExpenseAnalysis

StartDocumentTextDetection