@aws-sdk/client-comprehend 3.934.0 → 3.936.0

package/dist-types/models/enums.d.ts

@@ -0,0 +1,555 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const AugmentedManifestsDocumentTypeFormat: {
+    readonly PLAIN_TEXT_DOCUMENT: "PLAIN_TEXT_DOCUMENT";
+    readonly SEMI_STRUCTURED_DOCUMENT: "SEMI_STRUCTURED_DOCUMENT";
+};
+/**
+ * @public
+ */
+export type AugmentedManifestsDocumentTypeFormat = (typeof AugmentedManifestsDocumentTypeFormat)[keyof typeof AugmentedManifestsDocumentTypeFormat];
+/**
+ * @public
+ * @enum
+ */
+export declare const Split: {
+    readonly TEST: "TEST";
+    readonly TRAIN: "TRAIN";
+};
+/**
+ * @public
+ */
+export type Split = (typeof Split)[keyof typeof Split];
+/**
+ * @public
+ * @enum
+ */
+export declare const InvalidRequestDetailReason: {
+    readonly DOCUMENT_SIZE_EXCEEDED: "DOCUMENT_SIZE_EXCEEDED";
+    readonly PAGE_LIMIT_EXCEEDED: "PAGE_LIMIT_EXCEEDED";
+    readonly TEXTRACT_ACCESS_DENIED: "TEXTRACT_ACCESS_DENIED";
+    readonly UNSUPPORTED_DOC_TYPE: "UNSUPPORTED_DOC_TYPE";
+};
+/**
+ * @public
+ */
+export type InvalidRequestDetailReason = (typeof InvalidRequestDetailReason)[keyof typeof InvalidRequestDetailReason];
+/**
+ * @public
+ * @enum
+ */
+export declare const InvalidRequestReason: {
+    readonly INVALID_DOCUMENT: "INVALID_DOCUMENT";
+};
+/**
+ * @public
+ */
+export type InvalidRequestReason = (typeof InvalidRequestReason)[keyof typeof InvalidRequestReason];
+/**
+ * @public
+ * @enum
+ */
+export declare const LanguageCode: {
+    readonly AR: "ar";
+    readonly DE: "de";
+    readonly EN: "en";
+    readonly ES: "es";
+    readonly FR: "fr";
+    readonly HI: "hi";
+    readonly IT: "it";
+    readonly JA: "ja";
+    readonly KO: "ko";
+    readonly PT: "pt";
+    readonly ZH: "zh";
+    readonly ZH_TW: "zh-TW";
+};
+/**
+ * @public
+ */
+export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode];
+/**
+ * @public
+ * @enum
+ */
+export declare const EntityType: {
+    readonly COMMERCIAL_ITEM: "COMMERCIAL_ITEM";
+    readonly DATE: "DATE";
+    readonly EVENT: "EVENT";
+    readonly LOCATION: "LOCATION";
+    readonly ORGANIZATION: "ORGANIZATION";
+    readonly OTHER: "OTHER";
+    readonly PERSON: "PERSON";
+    readonly QUANTITY: "QUANTITY";
+    readonly TITLE: "TITLE";
+};
+/**
+ * @public
+ */
+export type EntityType = (typeof EntityType)[keyof typeof EntityType];
+/**
+ * @public
+ * @enum
+ */
+export declare const SentimentType: {
+    readonly MIXED: "MIXED";
+    readonly NEGATIVE: "NEGATIVE";
+    readonly NEUTRAL: "NEUTRAL";
+    readonly POSITIVE: "POSITIVE";
+};
+/**
+ * @public
+ */
+export type SentimentType = (typeof SentimentType)[keyof typeof SentimentType];
+/**
+ * @public
+ * @enum
+ */
+export declare const SyntaxLanguageCode: {
+    readonly DE: "de";
+    readonly EN: "en";
+    readonly ES: "es";
+    readonly FR: "fr";
+    readonly IT: "it";
+    readonly PT: "pt";
+};
+/**
+ * @public
+ */
+export type SyntaxLanguageCode = (typeof SyntaxLanguageCode)[keyof typeof SyntaxLanguageCode];
+/**
+ * @public
+ * @enum
+ */
+export declare const PartOfSpeechTagType: {
+    readonly ADJ: "ADJ";
+    readonly ADP: "ADP";
+    readonly ADV: "ADV";
+    readonly AUX: "AUX";
+    readonly CCONJ: "CCONJ";
+    readonly CONJ: "CONJ";
+    readonly DET: "DET";
+    readonly INTJ: "INTJ";
+    readonly NOUN: "NOUN";
+    readonly NUM: "NUM";
+    readonly O: "O";
+    readonly PART: "PART";
+    readonly PRON: "PRON";
+    readonly PROPN: "PROPN";
+    readonly PUNCT: "PUNCT";
+    readonly SCONJ: "SCONJ";
+    readonly SYM: "SYM";
+    readonly VERB: "VERB";
+};
+/**
+ * @public
+ */
+export type PartOfSpeechTagType = (typeof PartOfSpeechTagType)[keyof typeof PartOfSpeechTagType];
+/**
+ * @public
+ * @enum
+ */
+export declare const TargetedSentimentEntityType: {
+    readonly ATTRIBUTE: "ATTRIBUTE";
+    readonly BOOK: "BOOK";
+    readonly BRAND: "BRAND";
+    readonly COMMERCIAL_ITEM: "COMMERCIAL_ITEM";
+    readonly DATE: "DATE";
+    readonly EVENT: "EVENT";
+    readonly FACILITY: "FACILITY";
+    readonly GAME: "GAME";
+    readonly LOCATION: "LOCATION";
+    readonly MOVIE: "MOVIE";
+    readonly MUSIC: "MUSIC";
+    readonly ORGANIZATION: "ORGANIZATION";
+    readonly OTHER: "OTHER";
+    readonly PERSON: "PERSON";
+    readonly PERSONAL_TITLE: "PERSONAL_TITLE";
+    readonly QUANTITY: "QUANTITY";
+    readonly SOFTWARE: "SOFTWARE";
+};
+/**
+ * @public
+ */
+export type TargetedSentimentEntityType = (typeof TargetedSentimentEntityType)[keyof typeof TargetedSentimentEntityType];
+/**
+ * @public
+ * @enum
+ */
+export declare const BlockType: {
+    readonly LINE: "LINE";
+    readonly WORD: "WORD";
+};
+/**
+ * @public
+ */
+export type BlockType = (typeof BlockType)[keyof typeof BlockType];
+/**
+ * @public
+ * @enum
+ */
+export declare const RelationshipType: {
+    readonly CHILD: "CHILD";
+};
+/**
+ * @public
+ */
+export type RelationshipType = (typeof RelationshipType)[keyof typeof RelationshipType];
+/**
+ * @public
+ * @enum
+ */
+export declare const DocumentReadAction: {
+    readonly TEXTRACT_ANALYZE_DOCUMENT: "TEXTRACT_ANALYZE_DOCUMENT";
+    readonly TEXTRACT_DETECT_DOCUMENT_TEXT: "TEXTRACT_DETECT_DOCUMENT_TEXT";
+};
+/**
+ * @public
+ */
+export type DocumentReadAction = (typeof DocumentReadAction)[keyof typeof DocumentReadAction];
+/**
+ * @public
+ * @enum
+ */
+export declare const DocumentReadMode: {
+    readonly FORCE_DOCUMENT_READ_ACTION: "FORCE_DOCUMENT_READ_ACTION";
+    readonly SERVICE_DEFAULT: "SERVICE_DEFAULT";
+};
+/**
+ * @public
+ */
+export type DocumentReadMode = (typeof DocumentReadMode)[keyof typeof DocumentReadMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const DocumentReadFeatureTypes: {
+    readonly FORMS: "FORMS";
+    readonly TABLES: "TABLES";
+};
+/**
+ * @public
+ */
+export type DocumentReadFeatureTypes = (typeof DocumentReadFeatureTypes)[keyof typeof DocumentReadFeatureTypes];
+/**
+ * @public
+ * @enum
+ */
+export declare const DocumentType: {
+    readonly IMAGE: "IMAGE";
+    readonly MS_WORD: "MS_WORD";
+    readonly NATIVE_PDF: "NATIVE_PDF";
+    readonly PLAIN_TEXT: "PLAIN_TEXT";
+    readonly SCANNED_PDF: "SCANNED_PDF";
+    readonly TEXTRACT_ANALYZE_DOCUMENT_JSON: "TEXTRACT_ANALYZE_DOCUMENT_JSON";
+    readonly TEXTRACT_DETECT_DOCUMENT_TEXT_JSON: "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON";
+};
+/**
+ * @public
+ */
+export type DocumentType = (typeof DocumentType)[keyof typeof DocumentType];
+/**
+ * @public
+ * @enum
+ */
+export declare const PageBasedErrorCode: {
+    readonly INTERNAL_SERVER_ERROR: "INTERNAL_SERVER_ERROR";
+    readonly PAGE_CHARACTERS_EXCEEDED: "PAGE_CHARACTERS_EXCEEDED";
+    readonly PAGE_SIZE_EXCEEDED: "PAGE_SIZE_EXCEEDED";
+    readonly TEXTRACT_BAD_PAGE: "TEXTRACT_BAD_PAGE";
+    readonly TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED: "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED";
+};
+/**
+ * @public
+ */
+export type PageBasedErrorCode = (typeof PageBasedErrorCode)[keyof typeof PageBasedErrorCode];
+/**
+ * @public
+ * @enum
+ */
+export declare const PageBasedWarningCode: {
+    readonly INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL: "INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL";
+    readonly INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL: "INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL";
+};
+/**
+ * @public
+ */
+export type PageBasedWarningCode = (typeof PageBasedWarningCode)[keyof typeof PageBasedWarningCode];
+/**
+ * @public
+ * @enum
+ */
+export declare const PiiEntityType: {
+    readonly ADDRESS: "ADDRESS";
+    readonly AGE: "AGE";
+    readonly ALL: "ALL";
+    readonly AWS_ACCESS_KEY: "AWS_ACCESS_KEY";
+    readonly AWS_SECRET_KEY: "AWS_SECRET_KEY";
+    readonly BANK_ACCOUNT_NUMBER: "BANK_ACCOUNT_NUMBER";
+    readonly BANK_ROUTING: "BANK_ROUTING";
+    readonly CA_HEALTH_NUMBER: "CA_HEALTH_NUMBER";
+    readonly CA_SOCIAL_INSURANCE_NUMBER: "CA_SOCIAL_INSURANCE_NUMBER";
+    readonly CREDIT_DEBIT_CVV: "CREDIT_DEBIT_CVV";
+    readonly CREDIT_DEBIT_EXPIRY: "CREDIT_DEBIT_EXPIRY";
+    readonly CREDIT_DEBIT_NUMBER: "CREDIT_DEBIT_NUMBER";
+    readonly DATE_TIME: "DATE_TIME";
+    readonly DRIVER_ID: "DRIVER_ID";
+    readonly EMAIL: "EMAIL";
+    readonly INTERNATIONAL_BANK_ACCOUNT_NUMBER: "INTERNATIONAL_BANK_ACCOUNT_NUMBER";
+    readonly IN_AADHAAR: "IN_AADHAAR";
+    readonly IN_NREGA: "IN_NREGA";
+    readonly IN_PERMANENT_ACCOUNT_NUMBER: "IN_PERMANENT_ACCOUNT_NUMBER";
+    readonly IN_VOTER_NUMBER: "IN_VOTER_NUMBER";
+    readonly IP_ADDRESS: "IP_ADDRESS";
+    readonly LICENSE_PLATE: "LICENSE_PLATE";
+    readonly MAC_ADDRESS: "MAC_ADDRESS";
+    readonly NAME: "NAME";
+    readonly PASSPORT_NUMBER: "PASSPORT_NUMBER";
+    readonly PASSWORD: "PASSWORD";
+    readonly PHONE: "PHONE";
+    readonly PIN: "PIN";
+    readonly SSN: "SSN";
+    readonly SWIFT_CODE: "SWIFT_CODE";
+    readonly UK_NATIONAL_HEALTH_SERVICE_NUMBER: "UK_NATIONAL_HEALTH_SERVICE_NUMBER";
+    readonly UK_NATIONAL_INSURANCE_NUMBER: "UK_NATIONAL_INSURANCE_NUMBER";
+    readonly UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER: "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER";
+    readonly URL: "URL";
+    readonly USERNAME: "USERNAME";
+    readonly US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER: "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER";
+    readonly VEHICLE_IDENTIFICATION_NUMBER: "VEHICLE_IDENTIFICATION_NUMBER";
+};
+/**
+ * @public
+ */
+export type PiiEntityType = (typeof PiiEntityType)[keyof typeof PiiEntityType];
+/**
+ * @public
+ * @enum
+ */
+export declare const DatasetType: {
+    readonly TEST: "TEST";
+    readonly TRAIN: "TRAIN";
+};
+/**
+ * @public
+ */
+export type DatasetType = (typeof DatasetType)[keyof typeof DatasetType];
+/**
+ * @public
+ * @enum
+ */
+export declare const DatasetDataFormat: {
+    readonly AUGMENTED_MANIFEST: "AUGMENTED_MANIFEST";
+    readonly COMPREHEND_CSV: "COMPREHEND_CSV";
+};
+/**
+ * @public
+ */
+export type DatasetDataFormat = (typeof DatasetDataFormat)[keyof typeof DatasetDataFormat];
+/**
+ * @public
+ * @enum
+ */
+export declare const InputFormat: {
+    readonly ONE_DOC_PER_FILE: "ONE_DOC_PER_FILE";
+    readonly ONE_DOC_PER_LINE: "ONE_DOC_PER_LINE";
+};
+/**
+ * @public
+ */
+export type InputFormat = (typeof InputFormat)[keyof typeof InputFormat];
+/**
+ * @public
+ * @enum
+ */
+export declare const DocumentClassifierDataFormat: {
+    readonly AUGMENTED_MANIFEST: "AUGMENTED_MANIFEST";
+    readonly COMPREHEND_CSV: "COMPREHEND_CSV";
+};
+/**
+ * @public
+ */
+export type DocumentClassifierDataFormat = (typeof DocumentClassifierDataFormat)[keyof typeof DocumentClassifierDataFormat];
+/**
+ * @public
+ * @enum
+ */
+export declare const DocumentClassifierDocumentTypeFormat: {
+    readonly PLAIN_TEXT_DOCUMENT: "PLAIN_TEXT_DOCUMENT";
+    readonly SEMI_STRUCTURED_DOCUMENT: "SEMI_STRUCTURED_DOCUMENT";
+};
+/**
+ * @public
+ */
+export type DocumentClassifierDocumentTypeFormat = (typeof DocumentClassifierDocumentTypeFormat)[keyof typeof DocumentClassifierDocumentTypeFormat];
+/**
+ * @public
+ * @enum
+ */
+export declare const DocumentClassifierMode: {
+    readonly MULTI_CLASS: "MULTI_CLASS";
+    readonly MULTI_LABEL: "MULTI_LABEL";
+};
+/**
+ * @public
+ */
+export type DocumentClassifierMode = (typeof DocumentClassifierMode)[keyof typeof DocumentClassifierMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const EntityRecognizerDataFormat: {
+    readonly AUGMENTED_MANIFEST: "AUGMENTED_MANIFEST";
+    readonly COMPREHEND_CSV: "COMPREHEND_CSV";
+};
+/**
+ * @public
+ */
+export type EntityRecognizerDataFormat = (typeof EntityRecognizerDataFormat)[keyof typeof EntityRecognizerDataFormat];
+/**
+ * @public
+ * @enum
+ */
+export declare const ModelType: {
+    readonly DOCUMENT_CLASSIFIER: "DOCUMENT_CLASSIFIER";
+    readonly ENTITY_RECOGNIZER: "ENTITY_RECOGNIZER";
+};
+/**
+ * @public
+ */
+export type ModelType = (typeof ModelType)[keyof typeof ModelType];
+/**
+ * @public
+ * @enum
+ */
+export declare const DatasetStatus: {
+    readonly COMPLETED: "COMPLETED";
+    readonly CREATING: "CREATING";
+    readonly FAILED: "FAILED";
+};
+/**
+ * @public
+ */
+export type DatasetStatus = (typeof DatasetStatus)[keyof typeof DatasetStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const JobStatus: {
+    readonly COMPLETED: "COMPLETED";
+    readonly FAILED: "FAILED";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly STOPPED: "STOPPED";
+    readonly STOP_REQUESTED: "STOP_REQUESTED";
+    readonly SUBMITTED: "SUBMITTED";
+};
+/**
+ * @public
+ */
+export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const ModelStatus: {
+    readonly DELETING: "DELETING";
+    readonly IN_ERROR: "IN_ERROR";
+    readonly STOPPED: "STOPPED";
+    readonly STOP_REQUESTED: "STOP_REQUESTED";
+    readonly SUBMITTED: "SUBMITTED";
+    readonly TRAINED: "TRAINED";
+    readonly TRAINED_WITH_WARNING: "TRAINED_WITH_WARNING";
+    readonly TRAINING: "TRAINING";
+};
+/**
+ * @public
+ */
+export type ModelStatus = (typeof ModelStatus)[keyof typeof ModelStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const EndpointStatus: {
+    readonly CREATING: "CREATING";
+    readonly DELETING: "DELETING";
+    readonly FAILED: "FAILED";
+    readonly IN_SERVICE: "IN_SERVICE";
+    readonly UPDATING: "UPDATING";
+};
+/**
+ * @public
+ */
+export type EndpointStatus = (typeof EndpointStatus)[keyof typeof EndpointStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const FlywheelStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly CREATING: "CREATING";
+    readonly DELETING: "DELETING";
+    readonly FAILED: "FAILED";
+    readonly UPDATING: "UPDATING";
+};
+/**
+ * @public
+ */
+export type FlywheelStatus = (typeof FlywheelStatus)[keyof typeof FlywheelStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const FlywheelIterationStatus: {
+    readonly COMPLETED: "COMPLETED";
+    readonly EVALUATING: "EVALUATING";
+    readonly FAILED: "FAILED";
+    readonly STOPPED: "STOPPED";
+    readonly STOP_REQUESTED: "STOP_REQUESTED";
+    readonly TRAINING: "TRAINING";
+};
+/**
+ * @public
+ */
+export type FlywheelIterationStatus = (typeof FlywheelIterationStatus)[keyof typeof FlywheelIterationStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const PiiEntitiesDetectionMode: {
+    readonly ONLY_OFFSETS: "ONLY_OFFSETS";
+    readonly ONLY_REDACTION: "ONLY_REDACTION";
+};
+/**
+ * @public
+ */
+export type PiiEntitiesDetectionMode = (typeof PiiEntitiesDetectionMode)[keyof typeof PiiEntitiesDetectionMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const PiiEntitiesDetectionMaskMode: {
+    readonly MASK: "MASK";
+    readonly REPLACE_WITH_PII_ENTITY_TYPE: "REPLACE_WITH_PII_ENTITY_TYPE";
+};
+/**
+ * @public
+ */
+export type PiiEntitiesDetectionMaskMode = (typeof PiiEntitiesDetectionMaskMode)[keyof typeof PiiEntitiesDetectionMaskMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const ToxicContentType: {
+    readonly GRAPHIC: "GRAPHIC";
+    readonly HARASSMENT_OR_ABUSE: "HARASSMENT_OR_ABUSE";
+    readonly HATE_SPEECH: "HATE_SPEECH";
+    readonly INSULT: "INSULT";
+    readonly PROFANITY: "PROFANITY";
+    readonly SEXUAL: "SEXUAL";
+    readonly VIOLENCE_OR_THREAT: "VIOLENCE_OR_THREAT";
+};
+/**
+ * @public
+ */
+export type ToxicContentType = (typeof ToxicContentType)[keyof typeof ToxicContentType];