Skip to content

Commit 97ad78e

Browse files
feat(aws-android-sdk-textract): update models to latest (#3092)
Co-authored-by: Tyler Roach <[email protected]>
1 parent bd3b631 commit 97ad78e

File tree

63 files changed

+9508
-60
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+9508
-60
lines changed

aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/AmazonTextract.java

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,14 @@ public interface AmazonTextract {
121121
* </li>
122122
* <li>
123123
* <p>
124+
* Signatures. A SIGNATURE <code>Block</code> object contains the location
125+
* information of a signature in a document. If used in conjunction with
126+
* forms or tables, a signature can be given a Key-Value pairing or be
127+
* detected in the cell of a table.
128+
* </p>
129+
* </li>
130+
* <li>
131+
* <p>
124132
* Query. A QUERY Block object contains the query text, alias and link to
125133
* the associated Query results block object.
126134
* </p>
@@ -554,6 +562,97 @@ GetDocumentTextDetectionResult getDocumentTextDetection(
554562
GetExpenseAnalysisResult getExpenseAnalysis(GetExpenseAnalysisRequest getExpenseAnalysisRequest)
555563
throws AmazonClientException, AmazonServiceException;
556564

565+
/**
566+
* <p>
567+
* Gets the results for an Amazon Textract asynchronous operation that
568+
* analyzes text in a lending document.
569+
* </p>
570+
* <p>
571+
* You start asynchronous text analysis by calling
572+
* <code>StartLendingAnalysis</code>, which returns a job identifier (
573+
* <code>JobId</code>). When the text analysis operation finishes, Amazon
574+
* Textract publishes a completion status to the Amazon Simple Notification
575+
* Service (Amazon SNS) topic that's registered in the initial call to
576+
* <code>StartLendingAnalysis</code>.
577+
* </p>
578+
* <p>
579+
* To get the results of the text analysis operation, first check that the
580+
* status value published to the Amazon SNS topic is SUCCEEDED. If so, call
581+
* GetLendingAnalysis, and pass the job identifier (<code>JobId</code>) from
582+
* the initial call to <code>StartLendingAnalysis</code>.
583+
* </p>
584+
*
585+
* @param getLendingAnalysisRequest
586+
* @return getLendingAnalysisResult The response from the GetLendingAnalysis
587+
* service method, as returned by Amazon Textract.
588+
* @throws InvalidParameterException
589+
* @throws AccessDeniedException
590+
* @throws ProvisionedThroughputExceededException
591+
* @throws InvalidJobIdException
592+
* @throws InternalServerErrorException
593+
* @throws ThrottlingException
594+
* @throws InvalidS3ObjectException
595+
* @throws InvalidKMSKeyException
596+
* @throws AmazonClientException If any internal errors are encountered
597+
* inside the client while attempting to make the request or
598+
* handle the response. For example if a network connection is
599+
* not available.
600+
* @throws AmazonServiceException If an error response is returned by Amazon
601+
* Textract indicating either a problem with the data in the
602+
* request, or a server side issue.
603+
*/
604+
GetLendingAnalysisResult getLendingAnalysis(GetLendingAnalysisRequest getLendingAnalysisRequest)
605+
throws AmazonClientException, AmazonServiceException;
606+
607+
/**
608+
* <p>
609+
* Gets summarized results for the <code>StartLendingAnalysis</code>
610+
* operation, which analyzes text in a lending document. The returned
611+
* summary consists of information about documents grouped together by a
612+
* common document type. Information like detected signatures, page numbers,
613+
* and split documents is returned with respect to the type of grouped
614+
* document.
615+
* </p>
616+
* <p>
617+
* You start asynchronous text analysis by calling
618+
* <code>StartLendingAnalysis</code>, which returns a job identifier (
619+
* <code>JobId</code>). When the text analysis operation finishes, Amazon
620+
* Textract publishes a completion status to the Amazon Simple Notification
621+
* Service (Amazon SNS) topic that's registered in the initial call to
622+
* <code>StartLendingAnalysis</code>.
623+
* </p>
624+
* <p>
625+
* To get the results of the text analysis operation, first check that the
626+
* status value published to the Amazon SNS topic is SUCCEEDED. If so, call
627+
* <code>GetLendingAnalysisSummary</code>, and pass the job identifier (
628+
* <code>JobId</code>) from the initial call to
629+
* <code>StartLendingAnalysis</code>.
630+
* </p>
631+
*
632+
* @param getLendingAnalysisSummaryRequest
633+
* @return getLendingAnalysisSummaryResult The response from the
634+
* GetLendingAnalysisSummary service method, as returned by Amazon
635+
* Textract.
636+
* @throws InvalidParameterException
637+
* @throws AccessDeniedException
638+
* @throws ProvisionedThroughputExceededException
639+
* @throws InvalidJobIdException
640+
* @throws InternalServerErrorException
641+
* @throws ThrottlingException
642+
* @throws InvalidS3ObjectException
643+
* @throws InvalidKMSKeyException
644+
* @throws AmazonClientException If any internal errors are encountered
645+
* inside the client while attempting to make the request or
646+
* handle the response. For example if a network connection is
647+
* not available.
648+
* @throws AmazonServiceException If an error response is returned by Amazon
649+
* Textract indicating either a problem with the data in the
650+
* request, or a server side issue.
651+
*/
652+
GetLendingAnalysisSummaryResult getLendingAnalysisSummary(
653+
GetLendingAnalysisSummaryRequest getLendingAnalysisSummaryRequest)
654+
throws AmazonClientException, AmazonServiceException;
655+
557656
/**
558657
* <p>
559658
* Starts the asynchronous analysis of an input document for relationships
@@ -728,6 +827,83 @@ StartExpenseAnalysisResult startExpenseAnalysis(
728827
StartExpenseAnalysisRequest startExpenseAnalysisRequest) throws AmazonClientException,
729828
AmazonServiceException;
730829

830+
/**
831+
* <p>
832+
* Starts the classification and analysis of an input document.
833+
* <code>StartLendingAnalysis</code> initiates the classification and
834+
* analysis of a packet of lending documents.
835+
* <code>StartLendingAnalysis</code> operates on a document file located in
836+
* an Amazon S3 bucket.
837+
* </p>
838+
* <p>
839+
* <code>StartLendingAnalysis</code> can analyze text in documents that are
840+
* in one of the following formats: JPEG, PNG, TIFF, PDF. Use
841+
* <code>DocumentLocation</code> to specify the bucket name and the file
842+
* name of the document.
843+
* </p>
844+
* <p>
845+
* <code>StartLendingAnalysis</code> returns a job identifier (
846+
* <code>JobId</code>) that you use to get the results of the operation.
847+
* When the text analysis is finished, Amazon Textract publishes a
848+
* completion status to the Amazon Simple Notification Service (Amazon SNS)
849+
* topic that you specify in <code>NotificationChannel</code>. To get the
850+
* results of the text analysis operation, first check that the status value
851+
* published to the Amazon SNS topic is SUCCEEDED. If the status is
852+
* SUCCEEDED you can call either <code>GetLendingAnalysis</code> or
853+
* <code>GetLendingAnalysisSummary</code> and provide the <code>JobId</code>
854+
* to obtain the results of the analysis.
855+
* </p>
856+
* <p>
857+
* If using <code>OutputConfig</code> to specify an Amazon S3 bucket, the
858+
* output will be contained within the specified prefix in a directory
859+
* labeled with the job-id. In the directory there are 3 sub-directories:
860+
* </p>
861+
* <ul>
862+
* <li>
863+
* <p>
864+
* detailedResponse (contains the GetLendingAnalysis response)
865+
* </p>
866+
* </li>
867+
* <li>
868+
* <p>
869+
* summaryResponse (for the GetLendingAnalysisSummary response)
870+
* </p>
871+
* </li>
872+
* <li>
873+
* <p>
874+
* splitDocuments (documents split across logical boundaries)
875+
* </p>
876+
* </li>
877+
* </ul>
878+
*
879+
* @param startLendingAnalysisRequest
880+
* @return startLendingAnalysisResult The response from the
881+
* StartLendingAnalysis service method, as returned by Amazon
882+
* Textract.
883+
* @throws InvalidParameterException
884+
* @throws InvalidS3ObjectException
885+
* @throws InvalidKMSKeyException
886+
* @throws UnsupportedDocumentException
887+
* @throws DocumentTooLargeException
888+
* @throws BadDocumentException
889+
* @throws AccessDeniedException
890+
* @throws ProvisionedThroughputExceededException
891+
* @throws InternalServerErrorException
892+
* @throws IdempotentParameterMismatchException
893+
* @throws ThrottlingException
894+
* @throws LimitExceededException
895+
* @throws AmazonClientException If any internal errors are encountered
896+
* inside the client while attempting to make the request or
897+
* handle the response. For example if a network connection is
898+
* not available.
899+
* @throws AmazonServiceException If an error response is returned by Amazon
900+
* Textract indicating either a problem with the data in the
901+
* request, or a server side issue.
902+
*/
903+
StartLendingAnalysisResult startLendingAnalysis(
904+
StartLendingAnalysisRequest startLendingAnalysisRequest) throws AmazonClientException,
905+
AmazonServiceException;
906+
731907
/**
732908
* Shuts down this client object, releasing any resources that might be held
733909
* open. This is an optional method, and callers are not expected to call

0 commit comments

Comments
 (0)