DescribeDocumentClassifier - Amazon Comprehend

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

DescribeDocumentClassifier

获取与文档分类器关联的属性。

请求语法

{ "DocumentClassifierArn": "string" }

请求参数

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

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

DocumentClassifierArn

标识文档分类器的 Amazon 资源名称 (ARN)。这些区域有:CreateDocumentClassifier操作在其响应中返回此标识符。

类型: 字符串

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

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

必需: 是

响应语法

{ "DocumentClassifierProperties": { "ClassifierMetadata": { "EvaluationMetrics": { "Accuracy": number, "F1Score": number, "HammingLoss": number, "MicroF1Score": number, "MicroPrecision": number, "MicroRecall": number, "Precision": number, "Recall": number }, "NumberOfLabels": number, "NumberOfTestDocuments": number, "NumberOfTrainedDocuments": number }, "DataAccessRoleArn": "string", "DocumentClassifierArn": "string", "EndTime": number, "InputDataConfig": { "AugmentedManifests": [ { "AnnotationDataS3Uri": "string", "AttributeNames": [ "string" ], "DocumentType": "string", "S3Uri": "string", "SourceDocumentsS3Uri": "string", "Split": "string" } ], "DataFormat": "string", "LabelDelimiter": "string", "S3Uri": "string", "TestS3Uri": "string" }, "LanguageCode": "string", "Message": "string", "Mode": "string", "ModelKmsKeyId": "string", "OutputDataConfig": { "KmsKeyId": "string", "S3Uri": "string" }, "SourceModelArn": "string", "Status": "string", "SubmitTime": number, "TrainingEndTime": number, "TrainingStartTime": number, "VersionName": "string", "VolumeKmsKeyId": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } }

响应元素

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

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

DocumentClassifierProperties

包含与文档分类器关联的属性的 Object。

类型:DocumentClassifierProperties 对象

错误

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

InternalServerException

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

HTTP 状态代码:500

InvalidRequestException

该请求无效。

HTTP 状态代码:400

ResourceNotFoundException

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

HTTP 状态代码:400

TooManyRequestsException

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

HTTP 状态代码:400

另请参阅

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