Module Values.StartLendingAnalysisResponseSource

Starts the classification and analysis of an input document. StartLendingAnalysis initiates the classification and analysis of a packet of lending documents. StartLendingAnalysis operates on a document file located in an Amazon S3 bucket. StartLendingAnalysis can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket name and the file name of the document. StartLendingAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When the text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId to obtain the results of the analysis. If using OutputConfig to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories: detailedResponse (contains the GetLendingAnalysis response) summaryResponse (for the GetLendingAnalysisSummary response) splitDocuments (documents split across logical boundaries)

Sourcetype nonrec t = {
  1. jobId : JobId.t option;
    (*

    A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `BadDocumentException of BadDocumentException.t
  3. | `DocumentTooLargeException of DocumentTooLargeException.t
  4. | `IdempotentParameterMismatchException of IdempotentParameterMismatchException.t
  5. | `InternalServerError of InternalServerError.t
  6. | `InvalidKMSKeyException of InvalidKMSKeyException.t
  7. | `InvalidParameterException of InvalidParameterException.t
  8. | `InvalidS3ObjectException of InvalidS3ObjectException.t
  9. | `LimitExceededException of LimitExceededException.t
  10. | `ProvisionedThroughputExceededException of ProvisionedThroughputExceededException.t
  11. | `ThrottlingException of ThrottlingException.t
  12. | `UnsupportedDocumentException of UnsupportedDocumentException.t
  13. | `Unknown_operation_error of string * string option
]
Sourceval make : ?jobId:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of unit | `BadDocumentException of unit | `DocumentTooLargeException of unit | `IdempotentParameterMismatchException of unit | `InternalServerError of unit | `InvalidKMSKeyException of unit | `InvalidParameterException of unit | `InvalidS3ObjectException of unit | `LimitExceededException 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 | `IdempotentParameterMismatchException of unit | `InternalServerError of unit | `InvalidKMSKeyException of unit | `InvalidParameterException of unit | `InvalidS3ObjectException of unit | `LimitExceededException 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 * [> `String of JobId.t ]) 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