import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { BatchDetectEntitiesRequest, BatchDetectEntitiesResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link BatchDetectEntitiesCommand}. */ export interface BatchDetectEntitiesCommandInput extends BatchDetectEntitiesRequest { } /** * @public * * The output of {@link BatchDetectEntitiesCommand}. */ export interface BatchDetectEntitiesCommandOutput extends BatchDetectEntitiesResponse, __MetadataBearer { } declare const BatchDetectEntitiesCommand_base: { new (input: BatchDetectEntitiesCommandInput): import("@smithy/core/client").CommandImpl; new (input: BatchDetectEntitiesCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Inspects the text of a batch of documents for named entities and returns information * about them. For more information about named entities, see * Entities in the Comprehend Developer Guide. *

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ComprehendClient, BatchDetectEntitiesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import * // const { ComprehendClient, BatchDetectEntitiesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import * // import type { ComprehendClientConfig } from "@aws-sdk/client-comprehend"; * const config = {}; // type is ComprehendClientConfig * const client = new ComprehendClient(config); * const input = { // BatchDetectEntitiesRequest * TextList: [ // CustomerInputStringList // required * "STRING_VALUE", * ], * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required * }; * const command = new BatchDetectEntitiesCommand(input); * const response = await client.send(command); * // { // BatchDetectEntitiesResponse * // ResultList: [ // ListOfDetectEntitiesResult // required * // { // BatchDetectEntitiesItemResult * // Index: Number("int"), * // Entities: [ // ListOfEntities * // { // Entity * // Score: Number("float"), * // Type: "PERSON" || "LOCATION" || "ORGANIZATION" || "COMMERCIAL_ITEM" || "EVENT" || "DATE" || "QUANTITY" || "TITLE" || "OTHER", * // Text: "STRING_VALUE", * // BeginOffset: Number("int"), * // EndOffset: Number("int"), * // BlockReferences: [ // ListOfBlockReferences * // { // BlockReference * // BlockId: "STRING_VALUE", * // BeginOffset: Number("int"), * // EndOffset: Number("int"), * // ChildBlocks: [ // ListOfChildBlocks * // { // ChildBlock * // ChildBlockId: "STRING_VALUE", * // BeginOffset: Number("int"), * // EndOffset: Number("int"), * // }, * // ], * // }, * // ], * // }, * // ], * // }, * // ], * // ErrorList: [ // BatchItemErrorList // required * // { // BatchItemError * // Index: Number("int"), * // ErrorCode: "STRING_VALUE", * // ErrorMessage: "STRING_VALUE", * // }, * // ], * // }; * * ``` * * @param BatchDetectEntitiesCommandInput - {@link BatchDetectEntitiesCommandInput} * @returns {@link BatchDetectEntitiesCommandOutput} * @see {@link BatchDetectEntitiesCommandInput} for command's `input` shape. * @see {@link BatchDetectEntitiesCommandOutput} for command's `response` shape. * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. * * @throws {@link BatchSizeLimitExceededException} (client fault) *

The number of documents in the request exceeds the limit of 25. Try your request again * with fewer documents.

* * @throws {@link InternalServerException} (server fault) *

An internal server error occurred. Retry your request.

* * @throws {@link InvalidRequestException} (client fault) *

The request is invalid.

* * @throws {@link TextSizeLimitExceededException} (client fault) *

The size of the input text exceeds the limit. Use a smaller document.

* * @throws {@link UnsupportedLanguageException} (client fault) *

Amazon Comprehend can't process the language of the input text. For a list of supported languages, * Supported languages in the Comprehend Developer Guide. *

* * @throws {@link ComprehendServiceException} *

Base exception class for all service exceptions from Comprehend service.

* * * @public */ export declare class BatchDetectEntitiesCommand extends BatchDetectEntitiesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: BatchDetectEntitiesRequest; output: BatchDetectEntitiesResponse; }; sdk: { input: BatchDetectEntitiesCommandInput; output: BatchDetectEntitiesCommandOutput; }; }; }