@aws-sdk/client-textract 3.35.0 → 3.36.0

package/src/Textract.ts

@@ -1,423 +0,0 @@
-import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
-
-import {
-  AnalyzeDocumentCommand,
-  AnalyzeDocumentCommandInput,
-  AnalyzeDocumentCommandOutput,
-} from "./commands/AnalyzeDocumentCommand";
-import {
-  AnalyzeExpenseCommand,
-  AnalyzeExpenseCommandInput,
-  AnalyzeExpenseCommandOutput,
-} from "./commands/AnalyzeExpenseCommand";
-import {
-  DetectDocumentTextCommand,
-  DetectDocumentTextCommandInput,
-  DetectDocumentTextCommandOutput,
-} from "./commands/DetectDocumentTextCommand";
-import {
-  GetDocumentAnalysisCommand,
-  GetDocumentAnalysisCommandInput,
-  GetDocumentAnalysisCommandOutput,
-} from "./commands/GetDocumentAnalysisCommand";
-import {
-  GetDocumentTextDetectionCommand,
-  GetDocumentTextDetectionCommandInput,
-  GetDocumentTextDetectionCommandOutput,
-} from "./commands/GetDocumentTextDetectionCommand";
-import {
-  StartDocumentAnalysisCommand,
-  StartDocumentAnalysisCommandInput,
-  StartDocumentAnalysisCommandOutput,
-} from "./commands/StartDocumentAnalysisCommand";
-import {
-  StartDocumentTextDetectionCommand,
-  StartDocumentTextDetectionCommandInput,
-  StartDocumentTextDetectionCommandOutput,
-} from "./commands/StartDocumentTextDetectionCommand";
-import { TextractClient } from "./TextractClient";
-
-/**
- * <p>Amazon Textract detects and analyzes text in documents and converts it
- *          into machine-readable text. This is the API reference documentation for
- *          Amazon Textract.</p>
- */
-export class Textract extends TextractClient {
-  /**
-   * <p>Analyzes an input document for relationships between detected items.  </p>
-   *          <p>The types of information returned are as follows: </p>
-   *          <ul>
-   *             <li>
-   *                <p>Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY
-   *                   <code>Block</code> object and a VALUE <code>Block</code> object. For example,
-   *                   <i>Name: Ana Silva Carolina</i> contains a key and value.
-   *                   <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is
-   *                the value.</p>
-   *             </li>
-   *             <li>
-   *                <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL
-   *                <code>Block</code> object is returned for each cell in a table.</p>
-   *             </li>
-   *             <li>
-   *                <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> 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 <code>FeatureTypes</code>). </p>
-   *             </li>
-   *          </ul>
-   *
-   *          <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.
-   *          A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,
-   *          including the selection status.</p>
-   *          <p>You can choose which type of analysis to perform by specifying the <code>FeatureTypes</code> list.
-   *       </p>
-   *          <p>The output is returned in a list of <code>Block</code> objects.</p>
-   *          <p>
-   *             <code>AnalyzeDocument</code> is a synchronous operation. To analyze documents
-   *       asynchronously, use <a>StartDocumentAnalysis</a>.</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>
-   */
-  public analyzeDocument(
-    args: AnalyzeDocumentCommandInput,
-    options?: __HttpHandlerOptions
-  ): Promise<AnalyzeDocumentCommandOutput>;
-  public analyzeDocument(
-    args: AnalyzeDocumentCommandInput,
-    cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void
-  ): void;
-  public analyzeDocument(
-    args: AnalyzeDocumentCommandInput,
-    options: __HttpHandlerOptions,
-    cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void
-  ): void;
-  public analyzeDocument(
-    args: AnalyzeDocumentCommandInput,
-    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AnalyzeDocumentCommandOutput) => void),
-    cb?: (err: any, data?: AnalyzeDocumentCommandOutput) => void
-  ): Promise<AnalyzeDocumentCommandOutput> | void {
-    const command = new AnalyzeDocumentCommand(args);
-    if (typeof optionsOrCb === "function") {
-      this.send(command, optionsOrCb);
-    } else if (typeof cb === "function") {
-      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
-      this.send(command, optionsOrCb || {}, cb);
-    } else {
-      return this.send(command, optionsOrCb);
-    }
-  }
-
-  /**
-   * <p>Analyzes an input document for financially related relationships between text.</p>
-   *          <p>Information is returned as <code>ExpenseDocuments</code> and seperated as follows.</p>
-   *          <ul>
-   *             <li>
-   *                <p>
-   *                   <code>LineItemGroups</code>- A data set containing <code>LineItems</code> which
-   *          store information about the lines of text, such as an item purchased and its price on a receipt.</p>
-   *             </li>
-   *             <li>
-   *                <p>
-   *                   <code>SummaryFields</code>- Contains all other information a receipt, such as header information
-   *          or the vendors name.</p>
-   *             </li>
-   *          </ul>
-   */
-  public analyzeExpense(
-    args: AnalyzeExpenseCommandInput,
-    options?: __HttpHandlerOptions
-  ): Promise<AnalyzeExpenseCommandOutput>;
-  public analyzeExpense(
-    args: AnalyzeExpenseCommandInput,
-    cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void
-  ): void;
-  public analyzeExpense(
-    args: AnalyzeExpenseCommandInput,
-    options: __HttpHandlerOptions,
-    cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void
-  ): void;
-  public analyzeExpense(
-    args: AnalyzeExpenseCommandInput,
-    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AnalyzeExpenseCommandOutput) => void),
-    cb?: (err: any, data?: AnalyzeExpenseCommandOutput) => void
-  ): Promise<AnalyzeExpenseCommandOutput> | void {
-    const command = new AnalyzeExpenseCommand(args);
-    if (typeof optionsOrCb === "function") {
-      this.send(command, optionsOrCb);
-    } else if (typeof cb === "function") {
-      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
-      this.send(command, optionsOrCb || {}, cb);
-    } else {
-      return this.send(command, optionsOrCb);
-    }
-  }
-
-  /**
-   * <p>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 an image in JPEG or PNG
-   *          format. <code>DetectDocumentText</code> returns the detected text in 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>
-   *             <code>DetectDocumentText</code> is a synchronous operation. To analyze documents
-   *          asynchronously, use <a>StartDocumentTextDetection</a>.</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>
-   */
-  public detectDocumentText(
-    args: DetectDocumentTextCommandInput,
-    options?: __HttpHandlerOptions
-  ): Promise<DetectDocumentTextCommandOutput>;
-  public detectDocumentText(
-    args: DetectDocumentTextCommandInput,
-    cb: (err: any, data?: DetectDocumentTextCommandOutput) => void
-  ): void;
-  public detectDocumentText(
-    args: DetectDocumentTextCommandInput,
-    options: __HttpHandlerOptions,
-    cb: (err: any, data?: DetectDocumentTextCommandOutput) => void
-  ): void;
-  public detectDocumentText(
-    args: DetectDocumentTextCommandInput,
-    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectDocumentTextCommandOutput) => void),
-    cb?: (err: any, data?: DetectDocumentTextCommandOutput) => void
-  ): Promise<DetectDocumentTextCommandOutput> | void {
-    const command = new DetectDocumentTextCommand(args);
-    if (typeof optionsOrCb === "function") {
-      this.send(command, optionsOrCb);
-    } else if (typeof cb === "function") {
-      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
-      this.send(command, optionsOrCb || {}, cb);
-    } else {
-      return this.send(command, optionsOrCb);
-    }
-  }
-
-  /**
-   * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.</p>
-   *          <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>, which returns a job identifier
-   *             (<code>JobId</code>). When the text analysis 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>StartDocumentAnalysis</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>GetDocumentAnalysis</code>, and pass the job identifier
-   *             (<code>JobId</code>) from the initial call to <code>StartDocumentAnalysis</code>.</p>
-   *          <p>
-   *             <code>GetDocumentAnalysis</code> returns an array of <a>Block</a> objects. The following
-   *          types of information are returned: </p>
-   *          <ul>
-   *             <li>
-   *                <p>Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY
-   *             <code>Block</code> object and a VALUE <code>Block</code> object. For example,
-   *             <i>Name: Ana Silva Carolina</i> contains a key and value.
-   *             <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is
-   *             the value.</p>
-   *             </li>
-   *             <li>
-   *                <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL
-   *             <code>Block</code> object is returned for each cell in a table.</p>
-   *             </li>
-   *             <li>
-   *                <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> 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 the <code>StartDocumentAnalysis</code>
-   *                   <code>FeatureTypes</code> input parameter). </p>
-   *             </li>
-   *          </ul>
-   *
-   *          <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.
-   *          A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,
-   *          including the selection status.</p>
-   *
-   *
-   *
-   *          <p>Use the <code>MaxResults</code> 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>GetDocumentAnalysis</code>, and populate the <code>NextToken</code> request
-   *          parameter with the token value that's returned from the previous call to
-   *             <code>GetDocumentAnalysis</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>
-   */
-  public getDocumentAnalysis(
-    args: GetDocumentAnalysisCommandInput,
-    options?: __HttpHandlerOptions
-  ): Promise<GetDocumentAnalysisCommandOutput>;
-  public getDocumentAnalysis(
-    args: GetDocumentAnalysisCommandInput,
-    cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void
-  ): void;
-  public getDocumentAnalysis(
-    args: GetDocumentAnalysisCommandInput,
-    options: __HttpHandlerOptions,
-    cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void
-  ): void;
-  public getDocumentAnalysis(
-    args: GetDocumentAnalysisCommandInput,
-    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentAnalysisCommandOutput) => void),
-    cb?: (err: any, data?: GetDocumentAnalysisCommandOutput) => void
-  ): Promise<GetDocumentAnalysisCommandOutput> | void {
-    const command = new GetDocumentAnalysisCommand(args);
-    if (typeof optionsOrCb === "function") {
-      this.send(command, optionsOrCb);
-    } else if (typeof cb === "function") {
-      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
-      this.send(command, optionsOrCb || {}, cb);
-    } else {
-      return this.send(command, optionsOrCb);
-    }
-  }
-
-  /**
-   * <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>
-   */
-  public getDocumentTextDetection(
-    args: GetDocumentTextDetectionCommandInput,
-    options?: __HttpHandlerOptions
-  ): Promise<GetDocumentTextDetectionCommandOutput>;
-  public getDocumentTextDetection(
-    args: GetDocumentTextDetectionCommandInput,
-    cb: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void
-  ): void;
-  public getDocumentTextDetection(
-    args: GetDocumentTextDetectionCommandInput,
-    options: __HttpHandlerOptions,
-    cb: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void
-  ): void;
-  public getDocumentTextDetection(
-    args: GetDocumentTextDetectionCommandInput,
-    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentTextDetectionCommandOutput) => void),
-    cb?: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void
-  ): Promise<GetDocumentTextDetectionCommandOutput> | void {
-    const command = new GetDocumentTextDetectionCommand(args);
-    if (typeof optionsOrCb === "function") {
-      this.send(command, optionsOrCb);
-    } else if (typeof cb === "function") {
-      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
-      this.send(command, optionsOrCb || {}, cb);
-    } else {
-      return this.send(command, optionsOrCb);
-    }
-  }
-
-  /**
-   * <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>
-   */
-  public startDocumentAnalysis(
-    args: StartDocumentAnalysisCommandInput,
-    options?: __HttpHandlerOptions
-  ): Promise<StartDocumentAnalysisCommandOutput>;
-  public startDocumentAnalysis(
-    args: StartDocumentAnalysisCommandInput,
-    cb: (err: any, data?: StartDocumentAnalysisCommandOutput) => void
-  ): void;
-  public startDocumentAnalysis(
-    args: StartDocumentAnalysisCommandInput,
-    options: __HttpHandlerOptions,
-    cb: (err: any, data?: StartDocumentAnalysisCommandOutput) => void
-  ): void;
-  public startDocumentAnalysis(
-    args: StartDocumentAnalysisCommandInput,
-    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDocumentAnalysisCommandOutput) => void),
-    cb?: (err: any, data?: StartDocumentAnalysisCommandOutput) => void
-  ): Promise<StartDocumentAnalysisCommandOutput> | void {
-    const command = new StartDocumentAnalysisCommand(args);
-    if (typeof optionsOrCb === "function") {
-      this.send(command, optionsOrCb);
-    } else if (typeof cb === "function") {
-      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
-      this.send(command, optionsOrCb || {}, cb);
-    } else {
-      return this.send(command, optionsOrCb);
-    }
-  }
-
-  /**
-   * <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>
-   */
-  public startDocumentTextDetection(
-    args: StartDocumentTextDetectionCommandInput,
-    options?: __HttpHandlerOptions
-  ): Promise<StartDocumentTextDetectionCommandOutput>;
-  public startDocumentTextDetection(
-    args: StartDocumentTextDetectionCommandInput,
-    cb: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void
-  ): void;
-  public startDocumentTextDetection(
-    args: StartDocumentTextDetectionCommandInput,
-    options: __HttpHandlerOptions,
-    cb: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void
-  ): void;
-  public startDocumentTextDetection(
-    args: StartDocumentTextDetectionCommandInput,
-    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDocumentTextDetectionCommandOutput) => void),
-    cb?: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void
-  ): Promise<StartDocumentTextDetectionCommandOutput> | void {
-    const command = new StartDocumentTextDetectionCommand(args);
-    if (typeof optionsOrCb === "function") {
-      this.send(command, optionsOrCb);
-    } else if (typeof cb === "function") {
-      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
-      this.send(command, optionsOrCb || {}, cb);
-    } else {
-      return this.send(command, optionsOrCb);
-    }
-  }
-}