@aws-sdk/client-textract 3.36.0 → 3.36.1

package/dist-types/ts3.4/commands/GetDocumentTextDetectionCommand.d.ts

@@ -6,53 +6,11 @@ export interface GetDocumentTextDetectionCommandInput extends GetDocumentTextDet
 }
 export interface GetDocumentTextDetectionCommandOutput extends GetDocumentTextDetectionResponse, __MetadataBearer {
 }
-/**
- * <p>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.</p>
- *          <p>You start asynchronous text detection by calling <a>StartDocumentTextDetection</a>, which returns a job identifier
- *             (<code>JobId</code>). When the text detection operation finishes, Amazon Textract publishes a
- *          completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to
- *             <code>StartDocumentTextDetection</code>. To get the results of the text-detection
- *          operation, first check that the status value published to the Amazon SNS topic is
- *             <code>SUCCEEDED</code>. If so, call <code>GetDocumentTextDetection</code>, and pass the
- *          job identifier (<code>JobId</code>) from the initial call to
- *             <code>StartDocumentTextDetection</code>.</p>
- *          <p>
- *             <code>GetDocumentTextDetection</code> returns an array of <a>Block</a>
- *          objects. </p>
- *          <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object
- *         is the parent of LINE <code>Block</code> objects that represent the lines of detected text on a page. A LINE <code>Block</code> object is
- *         a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
- *
- *          <p>Use the MaxResults parameter to limit the number of blocks that are returned. If there
- *          are more results than specified in <code>MaxResults</code>, the value of
- *             <code>NextToken</code> in the operation response contains a pagination token for getting
- *          the next set of results. To get the next page of results, call
- *             <code>GetDocumentTextDetection</code>, and populate the <code>NextToken</code> request
- *          parameter with the token value that's returned from the previous call to
- *             <code>GetDocumentTextDetection</code>.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { TextractClient, GetDocumentTextDetectionCommand } from "@aws-sdk/client-textract"; // ES Modules import
- * // const { TextractClient, GetDocumentTextDetectionCommand } = require("@aws-sdk/client-textract"); // CommonJS import
- * const client = new TextractClient(config);
- * const command = new GetDocumentTextDetectionCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link GetDocumentTextDetectionCommandInput} for command's `input` shape.
- * @see {@link GetDocumentTextDetectionCommandOutput} for command's `response` shape.
- * @see {@link TextractClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class GetDocumentTextDetectionCommand extends $Command<GetDocumentTextDetectionCommandInput, GetDocumentTextDetectionCommandOutput, TextractClientResolvedConfig> {
     readonly input: GetDocumentTextDetectionCommandInput;
     constructor(input: GetDocumentTextDetectionCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDocumentTextDetectionCommandInput, GetDocumentTextDetectionCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/StartDocumentAnalysisCommand.d.ts

@@ -6,46 +6,11 @@ export interface StartDocumentAnalysisCommandInput extends StartDocumentAnalysis
 }
 export interface StartDocumentAnalysisCommandOutput extends StartDocumentAnalysisResponse, __MetadataBearer {
 }
-/**
- * <p>Starts the asynchronous analysis of an input document for relationships between detected
- *          items such as key-value pairs, tables, and selection elements.</p>
- *
- *          <p>
- *             <code>StartDocumentAnalysis</code> can analyze text in documents that are in JPEG, PNG, and PDF format. The
- *          documents are stored in an Amazon S3 bucket. Use <a>DocumentLocation</a> to specify the bucket name and file name
- *          of the document.
- *          </p>
- *          <p>
- *             <code>StartDocumentAnalysis</code> returns a job identifier
- *             (<code>JobId</code>) that you use to get the results of the operation. When text
- *          analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS)
- *          topic that you specify in <code>NotificationChannel</code>. To get the results of the text
- *          analysis operation, first check that the status value published to the Amazon SNS topic is
- *             <code>SUCCEEDED</code>. If so, call <a>GetDocumentAnalysis</a>, and pass
- *          the job identifier (<code>JobId</code>) from the initial call to
- *             <code>StartDocumentAnalysis</code>.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text Analysis</a>.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { TextractClient, StartDocumentAnalysisCommand } from "@aws-sdk/client-textract"; // ES Modules import
- * // const { TextractClient, StartDocumentAnalysisCommand } = require("@aws-sdk/client-textract"); // CommonJS import
- * const client = new TextractClient(config);
- * const command = new StartDocumentAnalysisCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link StartDocumentAnalysisCommandInput} for command's `input` shape.
- * @see {@link StartDocumentAnalysisCommandOutput} for command's `response` shape.
- * @see {@link TextractClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class StartDocumentAnalysisCommand extends $Command<StartDocumentAnalysisCommandInput, StartDocumentAnalysisCommandOutput, TextractClientResolvedConfig> {
     readonly input: StartDocumentAnalysisCommandInput;
     constructor(input: StartDocumentAnalysisCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartDocumentAnalysisCommandInput, StartDocumentAnalysisCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/StartDocumentTextDetectionCommand.d.ts

@@ -6,45 +6,11 @@ export interface StartDocumentTextDetectionCommandInput extends StartDocumentTex
 }
 export interface StartDocumentTextDetectionCommandOutput extends StartDocumentTextDetectionResponse, __MetadataBearer {
 }
-/**
- * <p>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.</p>
- *          <p>
- *             <code>StartDocumentTextDetection</code> can analyze text in documents that are in JPEG, PNG, and PDF format. The
- *         documents are stored in an Amazon S3 bucket. Use <a>DocumentLocation</a> to specify the bucket name and file name
- *         of the document.
- *      </p>
- *          <p>
- *             <code>StartTextDetection</code> returns a job identifier
- *             (<code>JobId</code>) that you use to get the results of the operation. When text
- *          detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS)
- *          topic that you specify in <code>NotificationChannel</code>. To get the results of the text
- *          detection operation, first check that the status value published to the Amazon SNS topic is
- *             <code>SUCCEEDED</code>. If so, call <a>GetDocumentTextDetection</a>, and
- *          pass the job identifier (<code>JobId</code>) from the initial call to
- *             <code>StartDocumentTextDetection</code>.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { TextractClient, StartDocumentTextDetectionCommand } from "@aws-sdk/client-textract"; // ES Modules import
- * // const { TextractClient, StartDocumentTextDetectionCommand } = require("@aws-sdk/client-textract"); // CommonJS import
- * const client = new TextractClient(config);
- * const command = new StartDocumentTextDetectionCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link StartDocumentTextDetectionCommandInput} for command's `input` shape.
- * @see {@link StartDocumentTextDetectionCommandOutput} for command's `response` shape.
- * @see {@link TextractClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class StartDocumentTextDetectionCommand extends $Command<StartDocumentTextDetectionCommandInput, StartDocumentTextDetectionCommandOutput, TextractClientResolvedConfig> {
     readonly input: StartDocumentTextDetectionCommandInput;
     constructor(input: StartDocumentTextDetectionCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartDocumentTextDetectionCommandInput, StartDocumentTextDetectionCommandOutput>;
     private serialize;
     private deserialize;