import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeEntityRecognizerRequest, DescribeEntityRecognizerResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeEntityRecognizerCommand}. */ export interface DescribeEntityRecognizerCommandInput extends DescribeEntityRecognizerRequest { } /** * @public * * The output of {@link DescribeEntityRecognizerCommand}. */ export interface DescribeEntityRecognizerCommandOutput extends DescribeEntityRecognizerResponse, __MetadataBearer { } declare const DescribeEntityRecognizerCommand_base: { new (input: DescribeEntityRecognizerCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeEntityRecognizerCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Provides details about an entity recognizer including status, S3 buckets containing * training data, recognizer metadata, metrics, and so on.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ComprehendClient, DescribeEntityRecognizerCommand } from "@aws-sdk/client-comprehend"; // ES Modules import * // const { ComprehendClient, DescribeEntityRecognizerCommand } = 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 = { // DescribeEntityRecognizerRequest * EntityRecognizerArn: "STRING_VALUE", // required * }; * const command = new DescribeEntityRecognizerCommand(input); * const response = await client.send(command); * // { // DescribeEntityRecognizerResponse * // EntityRecognizerProperties: { // EntityRecognizerProperties * // EntityRecognizerArn: "STRING_VALUE", * // LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", * // Status: "SUBMITTED" || "TRAINING" || "DELETING" || "STOP_REQUESTED" || "STOPPED" || "IN_ERROR" || "TRAINED" || "TRAINED_WITH_WARNING", * // Message: "STRING_VALUE", * // SubmitTime: new Date("TIMESTAMP"), * // EndTime: new Date("TIMESTAMP"), * // TrainingStartTime: new Date("TIMESTAMP"), * // TrainingEndTime: new Date("TIMESTAMP"), * // InputDataConfig: { // EntityRecognizerInputDataConfig * // DataFormat: "COMPREHEND_CSV" || "AUGMENTED_MANIFEST", * // EntityTypes: [ // EntityTypesList // required * // { // EntityTypesListItem * // Type: "STRING_VALUE", // required * // }, * // ], * // Documents: { // EntityRecognizerDocuments * // S3Uri: "STRING_VALUE", // required * // TestS3Uri: "STRING_VALUE", * // InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE", * // }, * // Annotations: { // EntityRecognizerAnnotations * // S3Uri: "STRING_VALUE", // required * // TestS3Uri: "STRING_VALUE", * // }, * // EntityList: { // EntityRecognizerEntityList * // S3Uri: "STRING_VALUE", // required * // }, * // AugmentedManifests: [ // EntityRecognizerAugmentedManifestsList * // { // AugmentedManifestsListItem * // S3Uri: "STRING_VALUE", // required * // Split: "TRAIN" || "TEST", * // AttributeNames: [ // AttributeNamesList // required * // "STRING_VALUE", * // ], * // AnnotationDataS3Uri: "STRING_VALUE", * // SourceDocumentsS3Uri: "STRING_VALUE", * // DocumentType: "PLAIN_TEXT_DOCUMENT" || "SEMI_STRUCTURED_DOCUMENT", * // }, * // ], * // }, * // RecognizerMetadata: { // EntityRecognizerMetadata * // NumberOfTrainedDocuments: Number("int"), * // NumberOfTestDocuments: Number("int"), * // EvaluationMetrics: { // EntityRecognizerEvaluationMetrics * // Precision: Number("double"), * // Recall: Number("double"), * // F1Score: Number("double"), * // }, * // EntityTypes: [ // EntityRecognizerMetadataEntityTypesList * // { // EntityRecognizerMetadataEntityTypesListItem * // Type: "STRING_VALUE", * // EvaluationMetrics: { // EntityTypesEvaluationMetrics * // Precision: Number("double"), * // Recall: Number("double"), * // F1Score: Number("double"), * // }, * // NumberOfTrainMentions: Number("int"), * // }, * // ], * // }, * // DataAccessRoleArn: "STRING_VALUE", * // VolumeKmsKeyId: "STRING_VALUE", * // VpcConfig: { // VpcConfig * // SecurityGroupIds: [ // SecurityGroupIds // required * // "STRING_VALUE", * // ], * // Subnets: [ // Subnets // required * // "STRING_VALUE", * // ], * // }, * // ModelKmsKeyId: "STRING_VALUE", * // VersionName: "STRING_VALUE", * // SourceModelArn: "STRING_VALUE", * // FlywheelArn: "STRING_VALUE", * // OutputDataConfig: { // EntityRecognizerOutputDataConfig * // FlywheelStatsS3Prefix: "STRING_VALUE", * // }, * // }, * // }; * * ``` * * @param DescribeEntityRecognizerCommandInput - {@link DescribeEntityRecognizerCommandInput} * @returns {@link DescribeEntityRecognizerCommandOutput} * @see {@link DescribeEntityRecognizerCommandInput} for command's `input` shape. * @see {@link DescribeEntityRecognizerCommandOutput} for command's `response` shape. * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. * * @throws {@link InternalServerException} (server fault) *

An internal server error occurred. Retry your request.

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

The request is invalid.

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

The specified resource ARN was not found. Check the ARN and try your request again.

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

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ComprehendServiceException} *

Base exception class for all service exceptions from Comprehend service.

* * * @public */ export declare class DescribeEntityRecognizerCommand extends DescribeEntityRecognizerCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeEntityRecognizerRequest; output: DescribeEntityRecognizerResponse; }; sdk: { input: DescribeEntityRecognizerCommandInput; output: DescribeEntityRecognizerCommandOutput; }; }; }