StartEntitiesDetectionJob - Amazon Comprehend

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

StartEntitiesDetectionJob

为一组文档启动异步实体检测作业。使用DescribeEntitiesDetectionJob操作来跟踪作业的状态。

此 API 可用于标准实体检测或自定义实体识别。为了用于自定义实体识别,可选的EntityRecognizerArn必须使用,以便提供对用于检测自定义实体的识别器的访问权限。

请求语法

{ "ClientRequestToken": "string", "DataAccessRoleArn": "string", "EntityRecognizerArn": "string", "InputDataConfig": { "DocumentReaderConfig": { "DocumentReadAction": "string", "DocumentReadMode": "string", "FeatureTypes": [ "string" ] }, "InputFormat": "string", "S3Uri": "string" }, "JobName": "string", "LanguageCode": "string", "OutputDataConfig": { "KmsKeyId": "string", "S3Uri": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeKmsKeyId": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }

请求参数

有关所有操作的通用参数的信息,请参阅常见参数.

请求接受采用 JSON 格式的以下数据。

ClientRequestToken

请求的唯一标识符。如果您未设置客户端请求令牌,Amazon Comprehend 会生成一个令牌。

类型: 字符串

长度约束:最小长度为 1。最大长度为 64。

模式:^[a-zA-Z0-9-]+$

必需: 否

DataAccessRoleArn

Amazon 资源名称 (ARN),Amazon 资源名称 (ARN),AWS Identity and Access Management 名称 (ARN),Amazon 资源名称 (ARN),AAmazon Comprehend 资源名称 (ARN),Amazon 有关更多信息,请参阅 https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions

类型: 字符串

长度约束:最小长度为 20。长度上限为 2048。

模式:arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

必需: 是

EntityRecognizerArn

标识 Amazon 资源名称 (ARN),用于标识StartEntitiesDetectionJob. 此 ARN 是可选的,仅用于自定义实体识别作业。

类型: 字符串

长度约束:长度上限为 256。

模式:arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

必需: 否

InputDataConfig

指定作业的输入数据的格式和位置。

类型:InputDataConfig 对象

必需: 是

JobName

任务的标识符。

类型: 字符串

长度约束:最小长度为 1。长度上限为 256。

模式:^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

必需: 否

LanguageCode

输入文档的语言。所有文档必须使用相同的语言。您可以指定支持的任何语言的 Amazon Comprehend。如果使用自定义实体识别,则忽略此参数,而是使用用于训练模型的语言。

类型: 字符串

有效值: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW

必需: 是

OutputDataConfig

指定输出文件的发送位置。

类型:OutputDataConfig 对象

必需: 是

Tags

要与实体检测作业关联的标签。标签是键值对,用于向 Amazon Coment (Amazon) 的资源添加元数据的 Amazon 值对。例如,可以将以 “Sales” 作为密钥的标签添加到资源中,以指示销售部门使用该标签。

类型: 数组Tag对象

必需: 否

VolumeKmsKeyId

用于加密附加到用于自动分析作业的 ML 计算实例的存储卷上的数据的 AWS 密钥的 AWS 密钥的 AWS 密钥的 AWS 密钥的 AWS 密钥的 AWS 密钥的 AWS 密钥的 AWS 密钥的 AAmazon Comprehend 密钥的 这些区域有: VolumeKmsKeyId 可以是以下任一内容:

  • KMS 密钥 ID:"1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS 密钥的 Amazon 资源名称 (ARN):"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

类型: 字符串

长度约束:长度上限为 2048。

模式:^\p{ASCII}+$

必需: 否

VpcConfig

包含用于实体检测作业的资源的可选私有Virtual Private Cloud (VPC) 的配置参数。有关更多信息,请参阅 Amazon VPC

类型:VpcConfig 对象

必需: 否

响应语法

{ "JobArn": "string", "JobId": "string", "JobStatus": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

JobArn

实体检测作业的 Amazon 资源名称 (ARN)。它是任务唯一的完全限定标识符。它包括 AWS 账户、区域和任务 ID。ARN 的格式如下所示:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

以下是示例作业 ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

类型: 字符串

长度约束:长度上限为 256。

模式:arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

JobId

为任务生成的标识符。要获取作业的状态,请将此标识符与DescribeEntitiesDetectionJoboperation.

类型: 字符串

长度约束:最小长度为 1。长度上限为 32。

模式:^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

JobStatus

任务的状态。

  • 已提交-作业已收到,正在排队等待处理。

  • IN_PROGRESS-亚马逊 Compress 正在处理这份工作。

  • 已完成-作业已成功完成且输出可用。

  • 失败-任务未完成。要获取详细信息,请使用DescribeEntitiesDetectionJoboperation.

  • STOP_REQUESTED-亚马逊 Comprehend 已收到该任务的停止请求,正在处理该请求。

  • 已停止-作业已成功停止,但未完成。

类型: 字符串

有效值: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED

错误

有关所有操作共有的错误的信息,请参阅常见错误.

InternalServerException

发生内部服务器错误。重试您的请求。

HTTTTTTTTT 500

InvalidRequestException

该请求无效。

HTTTTTTTTT 400

KmsKeyValidationException

无法验证输入的 KMS 客户管理密钥 (CMK)。验证密钥并重新输入。

HTTTTTTTTT 400

ResourceNotFoundException

找不到指定的资源 ARN。检查该 ARN 并重试发送您的请求。

HTTTTTTTTT 400

ResourceUnavailableException

指定的资源不可用。检查资源并再次尝试请求。

HTTTTTTTTT 400

TooManyRequestsException

请求数超过了限制。稍后重新提交您的请求。

HTTTTTTTTT 400

TooManyTagsException

该请求包含的标签多于可以与资源关联的标签(每个资源 50 个标签)。标签的最大数量包括现有标签和当前请求中包含的标签。

HTTTTTTTTT 400

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: