AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Creates a classification request to analyze a single document in real-time. ClassifyDocument
supports the following model types:
Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.
Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying
input prompts for generative AI applications. For input, you provide English plain
text input. For prompt safety classification, the response includes only the Classes
field. For more information about prompt safety classifiers, see Prompt
safety classification in the Amazon Comprehend Developer Guide.
If the system detects errors while processing a page in the input document, the API
response includes an Errors field that describes the errors.
If the system detects a document-level error in your input document, the API returns
an InvalidRequestException error response. For details about this exception,
see
Errors in semi-structured documents in the Comprehend Developer Guide.
For .NET Core this operation is only available in asynchronous form. Please refer to ClassifyDocumentAsync.
Namespace: Amazon.Comprehend
Assembly: AWSSDK.Comprehend.dll
Version: 3.x.y.z
public virtual ClassifyDocumentResponse ClassifyDocument( ClassifyDocumentRequest request )
Container for the necessary parameters to execute the ClassifyDocument service method.
| Exception | Condition |
|---|---|
| InternalServerException | An internal server error occurred. Retry your request. |
| InvalidRequestException | The request is invalid. |
| ResourceUnavailableException | The specified resource is not available. Check the resource and try your request again. |
| TextSizeLimitExceededException | The size of the input text exceeds the limit. Use a smaller document. |
.NET Framework:
Supported in: 4.7.2 and newer