Module Values.AnalyzeDocumentResponseSource

Analyzes an input document for relationships between detected items. The types of information returned are as follows: Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value. Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table. Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes). Signatures. A SIGNATURE Block object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table. Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object. Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score. Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status. You can choose which type of analysis to perform by specifying the FeatureTypes list. The output is returned in a list of Block objects. AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis. For more information, see Document Text Analysis.

Sourcetype nonrec t = {
  1. documentMetadata : DocumentMetadata.t option;
    (*

    Metadata about the analyzed document. An example is the number of pages.

    *)
  2. blocks : BlockList.t option;
    (*

    The items that are detected and analyzed by AnalyzeDocument.

    *)
  3. humanLoopActivationOutput : HumanLoopActivationOutput.t option;
    (*

    Shows the results of the human in the loop evaluation.

    *)
  4. analyzeDocumentModelVersion : String_.t option;
    (*

    The version of the model used to analyze the document.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `BadDocumentException of BadDocumentException.t
  3. | `DocumentTooLargeException of DocumentTooLargeException.t
  4. | `HumanLoopQuotaExceededException of HumanLoopQuotaExceededException.t
  5. | `InternalServerError of InternalServerError.t
  6. | `InvalidParameterException of InvalidParameterException.t
  7. | `InvalidS3ObjectException of InvalidS3ObjectException.t
  8. | `ProvisionedThroughputExceededException of ProvisionedThroughputExceededException.t
  9. | `ThrottlingException of ThrottlingException.t
  10. | `UnsupportedDocumentException of UnsupportedDocumentException.t
  11. | `Unknown_operation_error of string * string option
]
Sourceval make : ?documentMetadata:??? -> ?blocks:??? -> ?humanLoopActivationOutput:??? -> ?analyzeDocumentModelVersion:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of unit | `BadDocumentException of unit | `DocumentTooLargeException of unit | `HumanLoopQuotaExceededException of HumanLoopQuotaExceededException.t | `InternalServerError of unit | `InvalidParameterException of unit | `InvalidS3ObjectException of unit | `ProvisionedThroughputExceededException of unit | `ThrottlingException of unit | `Unknown_operation_error of string * string option | `UnsupportedDocumentException of unit ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of unit | `BadDocumentException of unit | `DocumentTooLargeException of unit | `HumanLoopQuotaExceededException of HumanLoopQuotaExceededException.t | `InternalServerError of unit | `InvalidParameterException of unit | `InvalidS3ObjectException of unit | `ProvisionedThroughputExceededException of unit | `ThrottlingException of unit | `Unknown_operation_error of string * string option | `UnsupportedDocumentException of unit ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `Float of Percent.t | `Integer of UInteger.t | `List of [> `Enum of string | `Structure of (string * [> `Enum of string | `List of [> `String of NonEmptyString.t ] list ]) list ] list | `String of String_.t | `Structure of (string * [> `Float of Angle.t | `List of [> `String of QueryPage.t | `Structure of (string * [> `Float of Float_.t ]) list ] list | `String of QueryInput.t | `Structure of (string * [> `Float of Float_.t ]) list ]) list ]) list ] list | `String of String_.t | `Structure of (string * [> `Integer of UInteger.t | `List of [> `String of HumanLoopActivationReason.t ] list | `String of HumanLoopArn.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t