Smaws_Client_Textract (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_warning : 
  ?pages:Types.pages ->
  ?error_code:Types.error_code ->
  unit ->
  Types.warning

val make_update_adapter_response : 
  ?auto_update:Types.auto_update ->
  ?feature_types:Types.feature_types ->
  ?description:Types.adapter_description ->
  ?creation_time:Types.date_time ->
  ?adapter_name:Types.adapter_name ->
  ?adapter_id:Types.adapter_id ->
  unit ->
  Types.update_adapter_response

val make_update_adapter_request : 
  ?auto_update:Types.auto_update ->
  ?adapter_name:Types.adapter_name ->
  ?description:Types.adapter_description ->
  adapter_id:Types.adapter_id ->
  unit ->
  Types.update_adapter_request

val make_untag_resource_response : unit -> unit

val make_untag_resource_request : 
  tag_keys:Types.tag_key_list ->
  resource_ar_n:Types.amazon_resource_name ->
  unit ->
  Types.untag_resource_request

val make_undetected_signature : 
  ?page:Types.u_integer ->
  unit ->
  Types.undetected_signature

val make_tag_resource_response : unit -> unit

val make_tag_resource_request : 
  tags:Types.tag_map ->
  resource_ar_n:Types.amazon_resource_name ->
  unit ->
  Types.tag_resource_request

val make_start_lending_analysis_response : 
  ?job_id:Types.job_id ->
  unit ->
  Types.start_lending_analysis_response

val make_s3_object : 
  ?version:Types.s3_object_version ->
  ?name:Types.s3_object_name ->
  ?bucket:Types.s3_bucket ->
  unit ->
  Types.s3_object

val make_document_location : 
  ?s3_object:Types.s3_object ->
  unit ->
  Types.document_location

val make_notification_channel : 
  role_arn:Types.role_arn ->
  sns_topic_arn:Types.sns_topic_arn ->
  unit ->
  Types.notification_channel

val make_output_config : 
  ?s3_prefix:Types.s3_object_name ->
  s3_bucket:Types.s3_bucket ->
  unit ->
  Types.output_config

val make_start_lending_analysis_request : 
  ?kms_key_id:Types.kms_key_id ->
  ?output_config:Types.output_config ->
  ?notification_channel:Types.notification_channel ->
  ?job_tag:Types.job_tag ->
  ?client_request_token:Types.client_request_token ->
  document_location:Types.document_location ->
  unit ->
  Types.start_lending_analysis_request

val make_start_expense_analysis_response : 
  ?job_id:Types.job_id ->
  unit ->
  Types.start_expense_analysis_response

val make_start_expense_analysis_request : 
  ?kms_key_id:Types.kms_key_id ->
  ?output_config:Types.output_config ->
  ?notification_channel:Types.notification_channel ->
  ?job_tag:Types.job_tag ->
  ?client_request_token:Types.client_request_token ->
  document_location:Types.document_location ->
  unit ->
  Types.start_expense_analysis_request

val make_start_document_text_detection_response : 
  ?job_id:Types.job_id ->
  unit ->
  Types.start_document_text_detection_response

val make_start_document_text_detection_request : 
  ?kms_key_id:Types.kms_key_id ->
  ?output_config:Types.output_config ->
  ?notification_channel:Types.notification_channel ->
  ?job_tag:Types.job_tag ->
  ?client_request_token:Types.client_request_token ->
  document_location:Types.document_location ->
  unit ->
  Types.start_document_text_detection_request

val make_start_document_analysis_response : 
  ?job_id:Types.job_id ->
  unit ->
  Types.start_document_analysis_response

val make_query : 
  ?pages:Types.query_pages ->
  ?alias:Types.query_input ->
  text:Types.query_input ->
  unit ->
  Types.query

val make_queries_config : queries:Types.queries -> unit -> Types.queries_config

val make_adapter : 
  ?pages:Types.adapter_pages ->
  version:Types.adapter_version ->
  adapter_id:Types.adapter_id ->
  unit ->
  Types.adapter

val make_adapters_config : 
  adapters:Types.adapters ->
  unit ->
  Types.adapters_config

val make_start_document_analysis_request : 
  ?adapters_config:Types.adapters_config ->
  ?queries_config:Types.queries_config ->
  ?kms_key_id:Types.kms_key_id ->
  ?output_config:Types.output_config ->
  ?notification_channel:Types.notification_channel ->
  ?job_tag:Types.job_tag ->
  ?client_request_token:Types.client_request_token ->
  feature_types:Types.feature_types ->
  document_location:Types.document_location ->
  unit ->
  Types.start_document_analysis_request

val make_list_tags_for_resource_response : 
  ?tags:Types.tag_map ->
  unit ->
  Types.list_tags_for_resource_response

val make_list_tags_for_resource_request : 
  resource_ar_n:Types.amazon_resource_name ->
  unit ->
  Types.list_tags_for_resource_request

val make_adapter_version_overview : 
  ?status_message:Types.adapter_version_status_message ->
  ?status:Types.adapter_version_status ->
  ?feature_types:Types.feature_types ->
  ?creation_time:Types.date_time ->
  ?adapter_version:Types.adapter_version ->
  ?adapter_id:Types.adapter_id ->
  unit ->
  Types.adapter_version_overview

val make_list_adapter_versions_response : 
  ?next_token:Types.pagination_token ->
  ?adapter_versions:Types.adapter_version_list ->
  unit ->
  Types.list_adapter_versions_response

val make_list_adapter_versions_request : 
  ?next_token:Types.pagination_token ->
  ?max_results:Types.max_results ->
  ?before_creation_time:Types.date_time ->
  ?after_creation_time:Types.date_time ->
  ?adapter_id:Types.adapter_id ->
  unit ->
  Types.list_adapter_versions_request

val make_adapter_overview : 
  ?feature_types:Types.feature_types ->
  ?creation_time:Types.date_time ->
  ?adapter_name:Types.adapter_name ->
  ?adapter_id:Types.adapter_id ->
  unit ->
  Types.adapter_overview

val make_list_adapters_response : 
  ?next_token:Types.pagination_token ->
  ?adapters:Types.adapter_list ->
  unit ->
  Types.list_adapters_response

val make_list_adapters_request : 
  ?next_token:Types.pagination_token ->
  ?max_results:Types.max_results ->
  ?before_creation_time:Types.date_time ->
  ?after_creation_time:Types.date_time ->
  unit ->
  Types.list_adapters_request

val make_document_metadata : 
  ?pages:Types.u_integer ->
  unit ->
  Types.document_metadata

val make_split_document : 
  ?pages:Types.page_list ->
  ?index:Types.u_integer ->
  unit ->
  Types.split_document

val make_detected_signature : 
  ?page:Types.u_integer ->
  unit ->
  Types.detected_signature

val make_document_group : 
  ?undetected_signatures:Types.undetected_signature_list ->
  ?detected_signatures:Types.detected_signature_list ->
  ?split_documents:Types.split_document_list ->
  ?type_:Types.non_empty_string ->
  unit ->
  Types.document_group

val make_lending_summary : 
  ?undetected_document_types:Types.undetected_document_type_list ->
  ?document_groups:Types.document_group_list ->
  unit ->
  Types.lending_summary

val make_get_lending_analysis_summary_response : 
  ?analyze_lending_model_version:Types.string_ ->
  ?status_message:Types.status_message ->
  ?warnings:Types.warnings ->
  ?summary:Types.lending_summary ->
  ?job_status:Types.job_status ->
  ?document_metadata:Types.document_metadata ->
  unit ->
  Types.get_lending_analysis_summary_response

val make_get_lending_analysis_summary_request : 
  job_id:Types.job_id ->
  unit ->
  Types.get_lending_analysis_summary_request

val make_prediction : 
  ?confidence:Types.percent ->
  ?value:Types.non_empty_string ->
  unit ->
  Types.prediction

val make_page_classification : 
  page_number:Types.prediction_list ->
  page_type:Types.prediction_list ->
  unit ->
  Types.page_classification

val make_bounding_box : 
  ?top:Types.float_ ->
  ?left:Types.float_ ->
  ?height:Types.float_ ->
  ?width:Types.float_ ->
  unit ->
  Types.bounding_box

val make_point : ?y:Types.float_ -> ?x:Types.float_ -> unit -> Types.point

val make_geometry : 
  ?rotation_angle:Types.angle ->
  ?polygon:Types.polygon ->
  ?bounding_box:Types.bounding_box ->
  unit ->
  Types.geometry

val make_lending_detection : 
  ?confidence:Types.percent ->
  ?geometry:Types.geometry ->
  ?selection_status:Types.selection_status ->
  ?text:Types.string_ ->
  unit ->
  Types.lending_detection

val make_lending_field : 
  ?value_detections:Types.lending_detection_list ->
  ?key_detection:Types.lending_detection ->
  ?type_:Types.string_ ->
  unit ->
  Types.lending_field

val make_signature_detection : 
  ?geometry:Types.geometry ->
  ?confidence:Types.percent ->
  unit ->
  Types.signature_detection

val make_lending_document : 
  ?signature_detections:Types.signature_detection_list ->
  ?lending_fields:Types.lending_field_list ->
  unit ->
  Types.lending_document

val make_expense_type : 
  ?confidence:Types.percent ->
  ?text:Types.string_ ->
  unit ->
  Types.expense_type

val make_expense_detection : 
  ?confidence:Types.percent ->
  ?geometry:Types.geometry ->
  ?text:Types.string_ ->
  unit ->
  Types.expense_detection

val make_expense_currency : 
  ?confidence:Types.percent ->
  ?code:Types.string_ ->
  unit ->
  Types.expense_currency

val make_expense_group_property : 
  ?id:Types.string_ ->
  ?types:Types.string_list ->
  unit ->
  Types.expense_group_property

val make_expense_field : 
  ?group_properties:Types.expense_group_property_list ->
  ?currency:Types.expense_currency ->
  ?page_number:Types.u_integer ->
  ?value_detection:Types.expense_detection ->
  ?label_detection:Types.expense_detection ->
  ?type_:Types.expense_type ->
  unit ->
  Types.expense_field

val make_line_item_fields : 
  ?line_item_expense_fields:Types.expense_field_list ->
  unit ->
  Types.line_item_fields

val make_line_item_group : 
  ?line_items:Types.line_item_list ->
  ?line_item_group_index:Types.u_integer ->
  unit ->
  Types.line_item_group

val make_relationship : 
  ?ids:Types.id_list ->
  ?type_:Types.relationship_type ->
  unit ->
  Types.relationship

val make_block : 
  ?query:Types.query ->
  ?page:Types.u_integer ->
  ?selection_status:Types.selection_status ->
  ?entity_types:Types.entity_types ->
  ?relationships:Types.relationship_list ->
  ?id:Types.non_empty_string ->
  ?geometry:Types.geometry ->
  ?column_span:Types.u_integer ->
  ?row_span:Types.u_integer ->
  ?column_index:Types.u_integer ->
  ?row_index:Types.u_integer ->
  ?text_type:Types.text_type ->
  ?text:Types.string_ ->
  ?confidence:Types.percent ->
  ?block_type:Types.block_type ->
  unit ->
  Types.block

val make_expense_document : 
  ?blocks:Types.block_list ->
  ?line_item_groups:Types.line_item_group_list ->
  ?summary_fields:Types.expense_field_list ->
  ?expense_index:Types.u_integer ->
  unit ->
  Types.expense_document

val make_normalized_value : 
  ?value_type:Types.value_type ->
  ?value:Types.string_ ->
  unit ->
  Types.normalized_value

val make_analyze_id_detections : 
  ?confidence:Types.percent ->
  ?normalized_value:Types.normalized_value ->
  text:Types.string_ ->
  unit ->
  Types.analyze_id_detections

val make_identity_document_field : 
  ?value_detection:Types.analyze_id_detections ->
  ?type_:Types.analyze_id_detections ->
  unit ->
  Types.identity_document_field

val make_identity_document : 
  ?blocks:Types.block_list ->
  ?identity_document_fields:Types.identity_document_field_list ->
  ?document_index:Types.u_integer ->
  unit ->
  Types.identity_document

val make_extraction : 
  ?identity_document:Types.identity_document ->
  ?expense_document:Types.expense_document ->
  ?lending_document:Types.lending_document ->
  unit ->
  Types.extraction

val make_get_lending_analysis_response : 
  ?analyze_lending_model_version:Types.string_ ->
  ?status_message:Types.status_message ->
  ?warnings:Types.warnings ->
  ?results:Types.lending_result_list ->
  ?next_token:Types.pagination_token ->
  ?job_status:Types.job_status ->
  ?document_metadata:Types.document_metadata ->
  unit ->
  Types.get_lending_analysis_response

val make_get_lending_analysis_request : 
  ?next_token:Types.pagination_token ->
  ?max_results:Types.max_results ->
  job_id:Types.job_id ->
  unit ->
  Types.get_lending_analysis_request

val make_get_expense_analysis_response : 
  ?analyze_expense_model_version:Types.string_ ->
  ?status_message:Types.status_message ->
  ?warnings:Types.warnings ->
  ?expense_documents:Types.expense_document_list ->
  ?next_token:Types.pagination_token ->
  ?job_status:Types.job_status ->
  ?document_metadata:Types.document_metadata ->
  unit ->
  Types.get_expense_analysis_response

val make_get_expense_analysis_request : 
  ?next_token:Types.pagination_token ->
  ?max_results:Types.max_results ->
  job_id:Types.job_id ->
  unit ->
  Types.get_expense_analysis_request

val make_get_document_text_detection_response : 
  ?detect_document_text_model_version:Types.string_ ->
  ?status_message:Types.status_message ->
  ?warnings:Types.warnings ->
  ?blocks:Types.block_list ->
  ?next_token:Types.pagination_token ->
  ?job_status:Types.job_status ->
  ?document_metadata:Types.document_metadata ->
  unit ->
  Types.get_document_text_detection_response

val make_get_document_text_detection_request : 
  ?next_token:Types.pagination_token ->
  ?max_results:Types.max_results ->
  job_id:Types.job_id ->
  unit ->
  Types.get_document_text_detection_request

val make_get_document_analysis_response : 
  ?analyze_document_model_version:Types.string_ ->
  ?status_message:Types.status_message ->
  ?warnings:Types.warnings ->
  ?blocks:Types.block_list ->
  ?next_token:Types.pagination_token ->
  ?job_status:Types.job_status ->
  ?document_metadata:Types.document_metadata ->
  unit ->
  Types.get_document_analysis_response

val make_get_document_analysis_request : 
  ?next_token:Types.pagination_token ->
  ?max_results:Types.max_results ->
  job_id:Types.job_id ->
  unit ->
  Types.get_document_analysis_request

val make_adapter_version_dataset_config : 
  ?manifest_s3_object:Types.s3_object ->
  unit ->
  Types.adapter_version_dataset_config

val make_evaluation_metric : 
  ?recall:Types.float_ ->
  ?precision:Types.float_ ->
  ?f1_score:Types.float_ ->
  unit ->
  Types.evaluation_metric

val make_adapter_version_evaluation_metric : 
  ?feature_type:Types.feature_type ->
  ?adapter_version:Types.evaluation_metric ->
  ?baseline:Types.evaluation_metric ->
  unit ->
  Types.adapter_version_evaluation_metric

val make_get_adapter_version_response : 
  ?tags:Types.tag_map ->
  ?evaluation_metrics:Types.adapter_version_evaluation_metrics ->
  ?output_config:Types.output_config ->
  ?kms_key_id:Types.kms_key_id ->
  ?dataset_config:Types.adapter_version_dataset_config ->
  ?status_message:Types.adapter_version_status_message ->
  ?status:Types.adapter_version_status ->
  ?feature_types:Types.feature_types ->
  ?creation_time:Types.date_time ->
  ?adapter_version:Types.adapter_version ->
  ?adapter_id:Types.adapter_id ->
  unit ->
  Types.get_adapter_version_response

val make_get_adapter_version_request : 
  adapter_version:Types.adapter_version ->
  adapter_id:Types.adapter_id ->
  unit ->
  Types.get_adapter_version_request

val make_get_adapter_response : 
  ?tags:Types.tag_map ->
  ?auto_update:Types.auto_update ->
  ?feature_types:Types.feature_types ->
  ?description:Types.adapter_description ->
  ?creation_time:Types.date_time ->
  ?adapter_name:Types.adapter_name ->
  ?adapter_id:Types.adapter_id ->
  unit ->
  Types.get_adapter_response

val make_get_adapter_request : 
  adapter_id:Types.adapter_id ->
  unit ->
  Types.get_adapter_request

val make_detect_document_text_response : 
  ?detect_document_text_model_version:Types.string_ ->
  ?blocks:Types.block_list ->
  ?document_metadata:Types.document_metadata ->
  unit ->
  Types.detect_document_text_response

val make_document : 
  ?s3_object:Types.s3_object ->
  ?bytes:Types.image_blob ->
  unit ->
  Types.document

val make_detect_document_text_request : 
  document:Types.document ->
  unit ->
  Types.detect_document_text_request

val make_delete_adapter_version_response : unit -> unit

val make_delete_adapter_version_request : 
  adapter_version:Types.adapter_version ->
  adapter_id:Types.adapter_id ->
  unit ->
  Types.delete_adapter_version_request

val make_delete_adapter_response : unit -> unit

val make_delete_adapter_request : 
  adapter_id:Types.adapter_id ->
  unit ->
  Types.delete_adapter_request

val make_create_adapter_version_response : 
  ?adapter_version:Types.adapter_version ->
  ?adapter_id:Types.adapter_id ->
  unit ->
  Types.create_adapter_version_response

val make_create_adapter_version_request : 
  ?tags:Types.tag_map ->
  ?kms_key_id:Types.kms_key_id ->
  ?client_request_token:Types.client_request_token ->
  output_config:Types.output_config ->
  dataset_config:Types.adapter_version_dataset_config ->
  adapter_id:Types.adapter_id ->
  unit ->
  Types.create_adapter_version_request

val make_create_adapter_response : 
  ?adapter_id:Types.adapter_id ->
  unit ->
  Types.create_adapter_response

val make_create_adapter_request : 
  ?tags:Types.tag_map ->
  ?auto_update:Types.auto_update ->
  ?description:Types.adapter_description ->
  ?client_request_token:Types.client_request_token ->
  feature_types:Types.feature_types ->
  adapter_name:Types.adapter_name ->
  unit ->
  Types.create_adapter_request

val make_analyze_id_response : 
  ?analyze_id_model_version:Types.string_ ->
  ?document_metadata:Types.document_metadata ->
  ?identity_documents:Types.identity_document_list ->
  unit ->
  Types.analyze_id_response

val make_analyze_id_request : 
  document_pages:Types.document_pages ->
  unit ->
  Types.analyze_id_request

val make_analyze_expense_response : 
  ?expense_documents:Types.expense_document_list ->
  ?document_metadata:Types.document_metadata ->
  unit ->
  Types.analyze_expense_response

val make_analyze_expense_request : 
  document:Types.document ->
  unit ->
  Types.analyze_expense_request

val make_human_loop_activation_output : 
  ?human_loop_activation_conditions_evaluation_results:
    Types.synthesized_json_human_loop_activation_conditions_evaluation_results ->
  ?human_loop_activation_reasons:Types.human_loop_activation_reasons ->
  ?human_loop_arn:Types.human_loop_arn ->
  unit ->
  Types.human_loop_activation_output

val make_analyze_document_response : 
  ?analyze_document_model_version:Types.string_ ->
  ?human_loop_activation_output:Types.human_loop_activation_output ->
  ?blocks:Types.block_list ->
  ?document_metadata:Types.document_metadata ->
  unit ->
  Types.analyze_document_response

val make_human_loop_data_attributes : 
  ?content_classifiers:Types.content_classifiers ->
  unit ->
  Types.human_loop_data_attributes

val make_human_loop_config : 
  ?data_attributes:Types.human_loop_data_attributes ->
  flow_definition_arn:Types.flow_definition_arn ->
  human_loop_name:Types.human_loop_name ->
  unit ->
  Types.human_loop_config

val make_analyze_document_request : 
  ?adapters_config:Types.adapters_config ->
  ?queries_config:Types.queries_config ->
  ?human_loop_config:Types.human_loop_config ->
  feature_types:Types.feature_types ->
  document:Types.document ->
  unit ->
  Types.analyze_document_request

Operations

module AnalyzeDocument : sig ... end

Analyzes an input document for relationships between detected items.

module AnalyzeExpense : sig ... end

AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.

module AnalyzeID : sig ... end

Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, AnalyzeID doesn't return any Geometry data.

module CreateAdapter : sig ... end

Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.

module CreateAdapterVersion : sig ... end

Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.

module DeleteAdapter : sig ... end

Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.

module DeleteAdapterVersion : sig ... end

Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.

module DetectDocumentText : sig ... end

Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array of Block objects.

module GetAdapter : sig ... end

Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.

module GetAdapterVersion : sig ... end

Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

module GetDocumentAnalysis : sig ... end

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

module GetDocumentTextDetection : sig ... end

Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

module GetExpenseAnalysis : sig ... end

Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.

module GetLendingAnalysis : sig ... end

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.

module GetLendingAnalysisSummary : sig ... end

Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document.

module ListAdapters : sig ... end

Lists all adapters that match the specified filtration criteria.

module ListAdapterVersions : sig ... end

List all version of an adapter that meet the specified filtration criteria.

module ListTagsForResource : sig ... end

Lists all tags for an Amazon Textract resource.

module StartDocumentAnalysis : sig ... end

Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.

module StartDocumentTextDetection : sig ... end

Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

module StartExpenseAnalysis : sig ... end

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

module StartLendingAnalysis : sig ... end

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.

module TagResource : sig ... end

Adds one or more tags to the specified resource.

module UntagResource : sig ... end

Removes any tags with the specified keys from the specified resource.

module UpdateAdapter : sig ... end

module Json_serializers : sig ... end

module Json_deserializers : sig ... end