ClassifyDocument (smaws-clients.Smaws_Client

Module Smaws_Client_Comprehend.ClassifyDocument

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.

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsJson.error
  | `InternalServerException of Types.internal_server_exception
  | `InvalidRequestException of Types.invalid_request_exception
  | `ResourceUnavailableException of Types.resource_unavailable_exception
  | `TextSizeLimitExceededException of Types.text_size_limit_exceeded_exception ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.classify_document_request ->
  (Types.classify_document_response,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InternalServerException of Types.internal_server_exception
    | `InvalidRequestException of Types.invalid_request_exception
    | `ResourceUnavailableException of Types.resource_unavailable_exception
    | `TextSizeLimitExceededException of
      Types.text_size_limit_exceeded_exception ])
    Stdlib.result

val request_with_metadata : 
  'http_type Smaws_Lib.Context.t ->
  Types.classify_document_request ->
  (Types.classify_document_response Smaws_Lib.Response.t,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InternalServerException of Types.internal_server_exception
    | `InvalidRequestException of Types.invalid_request_exception
    | `ResourceUnavailableException of Types.resource_unavailable_exception
    | `TextSizeLimitExceededException of
      Types.text_size_limit_exceeded_exception ]
    * Smaws_Lib.Response.metadata)
    Stdlib.result