The locale to which specifies the language and region settings that determine the response + * language for QueryAssistant.
+ *Changing this locale to anything other than en_US will turn off
+ * recommendations triggered by contact transcripts for agent assistance, as this feature is
+ * not supported in multiple languages.
The locale to which specifies the language and region settings that determine the response + * language for QueryAssistant.
+ * @public + */ + locale?: string | undefined; } /** @@ -1602,7 +1621,7 @@ export interface GuardrailPiiEntityConfig { *- * REDIT_DEBIT_CARD_CVV + * CREDIT_DEBIT_CARD_CVV *
*A three-digit card verification code (CVV) that is present on VISA, MasterCard, * and Discover credit and debit cards. For American Express credit or debit cards, the diff --git a/codegen/sdk-codegen/aws-models/qconnect.json b/codegen/sdk-codegen/aws-models/qconnect.json index cad4576d3bfb..740839bec380 100644 --- a/codegen/sdk-codegen/aws-models/qconnect.json +++ b/codegen/sdk-codegen/aws-models/qconnect.json @@ -1299,6 +1299,12 @@ "traits": { "smithy.api#documentation": "
The association configurations for overriding behavior on this AI Agent.
" } + }, + "locale": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "The locale to which specifies the language and region settings that determine the response\n language for QueryAssistant.
\nChanging this locale to anything other than en_US will turn off\n recommendations triggered by contact transcripts for agent assistance, as this feature is\n not supported in multiple languages.
Configure AI Guardrail type when the PII entity is detected.
\nThe following PIIs are used to block or mask sensitive information:
\n\n General\n
\n\n ADDRESS\n
\nA physical address, such as \"100 Main Street, Anytown, USA\" or \"Suite #12,\n Building 123\". An address can include information such as the street, building,\n location, city, state, country, county, zip code, precinct, and neighborhood.
\n\n AGE\n
\nAn individual's age, including the quantity and unit of time. For example, in the\n phrase \"I am 40 years old,\" Guarrails recognizes \"40 years\" as an age.
\n\n NAME\n
\nAn individual's name. This entity type does not include titles, such as Dr., Mr.,\n Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of\n organizations or addresses. For example, AI Guardrail recognizes the \"John Doe\n Organization\" as an organization, and it recognizes \"Jane Doe Street\" as an address.\n
\n\n EMAIL\n
\nAn email address, such as marymajor@email.com.
\n\n PHONE\n
\nA phone number. This entity type also includes fax and pager numbers.
\n\n USERNAME\n
\nA user name that identifies an account, such as a login name, screen name, nick\n name, or handle.
\n\n PASSWORD\n
\nAn alphanumeric string that is used as a password, such as \"*\n very20special#pass*\".
\n\n DRIVER_ID\n
\nThe number assigned to a driver's license, which is an official document\n permitting an individual to operate one or more motorized vehicles on a public road. A\n driver's license number consists of alphanumeric characters.
\n\n LICENSE_PLATE\n
\nA license plate for a vehicle is issued by the state or country where the vehicle\n is registered. The format for passenger vehicles is typically five to eight digits,\n consisting of upper-case letters and numbers. The format varies depending on the\n location of the issuing state or country.
\n\n VEHICLE_IDENTIFICATION_NUMBER\n
\nA Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content\n and format are defined in the ISO 3779 specification. Each\n country has specific codes and formats for VINs.
\n\n Finance\n
\n\n REDIT_DEBIT_CARD_CVV\n
\nA three-digit card verification code (CVV) that is present on VISA, MasterCard,\n and Discover credit and debit cards. For American Express credit or debit cards, the\n CVV is a four-digit numeric code.
\n\n CREDIT_DEBIT_CARD_EXPIRY\n
\nThe expiration date for a credit or debit card. This number is usually four digits\n long and is often formatted as month/year or\n MM/YY. AI Guardrail recognizes expiration dates such as\n 01/21, 01/2021, and Jan\n 2021.
\n\n CREDIT_DEBIT_CARD_NUMBER\n
\nThe number for a credit or debit card. These numbers can vary from 13 to 16 digits\n in length. However, Amazon Comprehend also recognizes credit or debit card numbers\n when only the last four digits are present.
\n\n PIN\n
\nA four-digit personal identification number (PIN) with which you can access your\n bank account.
\n\n INTERNATIONAL_BANK_ACCOUNT_NUMBER\n
\nAn International Bank Account Number has specific formats in each country. For\n more information, see \n www.iban.com/structure.
\n\n SWIFT_CODE\n
\nA SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a\n particular bank or branch. Banks use these codes for money transfers such as\n international wire transfers.
\nSWIFT codes consist of eight or 11 characters. The 11-digit codes refer to\n specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer\n to the head or primary office.
\n\n IT\n
\n\n IP_ADDRESS\n
\nAn IPv4 address, such as 198.51.100.0.
\n\n MAC_ADDRESS\n
\nA media access control (MAC) address is a unique identifier\n assigned to a network interface controller (NIC).
\n\n URL\n
\nA web address, such as www.example.com.
\n\n AWS_ACCESS_KEY\n
\nA unique identifier that's associated with a secret access key; you use the access\n key ID and secret access key to sign programmatic Amazon Web Services requests\n cryptographically.
\n\n AWS_SECRET_KEY\n
\nA unique identifier that's associated with an access key. You use the access key\n ID and secret access key to sign programmatic Amazon Web Services requests\n cryptographically.
\n\n USA specific\n
\n\n US_BANK_ACCOUNT_NUMBER\n
\nA US bank account number, which is typically 10 to 12 digits long.
\n\n US_BANK_ROUTING_NUMBER\n
\nA US bank account routing number. These are typically nine digits long,
\n\n US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER\n
\nA US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that\n starts with a \"9\" and contain a \"7\" or \"8\" as the fourth digit. An ITIN can be\n formatted with a space or a dash after the third and forth digits.
\n\n US_PASSPORT_NUMBER\n
\nA US passport number. Passport numbers range from six to nine alphanumeric\n characters.
\n\n US_SOCIAL_SECURITY_NUMBER\n
\nA US Social Security Number (SSN) is a nine-digit number that is issued to US\n citizens, permanent residents, and temporary working residents.
\n\n Canada specific\n
\n\n CA_HEALTH_NUMBER\n
\nA Canadian Health Service Number is a 10-digit unique identifier, required for\n individuals to access healthcare benefits.
\n\n CA_SOCIAL_INSURANCE_NUMBER\n
\nA Canadian Social Insurance Number (SIN) is a nine-digit unique identifier,\n required for individuals to access government programs and benefits.
\nThe SIN is formatted as three groups of three digits, such as \n 123-456-789. A SIN can be validated through a simple check-digit process\n called the Luhn\n algorithm .
\n\n UK Specific\n
\n\n UK_NATIONAL_HEALTH_SERVICE_NUMBER\n
\nA UK National Health Service Number is a 10-17 digit number, such as 485\n 555 3456. The current system formats the 10-digit number with spaces\n after the third and sixth digits. The final digit is an error-detecting\n checksum.
\n\n UK_NATIONAL_INSURANCE_NUMBER\n
\nA UK National Insurance Number (NINO) provides individuals with access to National\n Insurance (social security) benefits. It is also used for some purposes in the UK tax\n system.
\nThe number is nine digits long and starts with two letters, followed by six\n numbers and one letter. A NINO can be formatted with a space or a dash after the two\n letters and after the second, forth, and sixth digits.
\n\n UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER\n
\nA UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a\n taxpayer or a business.
\n\n Custom\n
\n\n Regex filter - You can use a regular expressions to\n define patterns for an AI Guardrail to recognize and act upon such as serial number,\n booking ID etc..
\nConfigure AI Guardrail type when the PII entity is detected.
\nThe following PIIs are used to block or mask sensitive information:
\n\n General\n
\n\n ADDRESS\n
\nA physical address, such as \"100 Main Street, Anytown, USA\" or \"Suite #12,\n Building 123\". An address can include information such as the street, building,\n location, city, state, country, county, zip code, precinct, and neighborhood.
\n\n AGE\n
\nAn individual's age, including the quantity and unit of time. For example, in the\n phrase \"I am 40 years old,\" Guarrails recognizes \"40 years\" as an age.
\n\n NAME\n
\nAn individual's name. This entity type does not include titles, such as Dr., Mr.,\n Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of\n organizations or addresses. For example, AI Guardrail recognizes the \"John Doe\n Organization\" as an organization, and it recognizes \"Jane Doe Street\" as an address.\n
\n\n EMAIL\n
\nAn email address, such as marymajor@email.com.
\n\n PHONE\n
\nA phone number. This entity type also includes fax and pager numbers.
\n\n USERNAME\n
\nA user name that identifies an account, such as a login name, screen name, nick\n name, or handle.
\n\n PASSWORD\n
\nAn alphanumeric string that is used as a password, such as \"*\n very20special#pass*\".
\n\n DRIVER_ID\n
\nThe number assigned to a driver's license, which is an official document\n permitting an individual to operate one or more motorized vehicles on a public road. A\n driver's license number consists of alphanumeric characters.
\n\n LICENSE_PLATE\n
\nA license plate for a vehicle is issued by the state or country where the vehicle\n is registered. The format for passenger vehicles is typically five to eight digits,\n consisting of upper-case letters and numbers. The format varies depending on the\n location of the issuing state or country.
\n\n VEHICLE_IDENTIFICATION_NUMBER\n
\nA Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content\n and format are defined in the ISO 3779 specification. Each\n country has specific codes and formats for VINs.
\n\n Finance\n
\n\n CREDIT_DEBIT_CARD_CVV\n
\nA three-digit card verification code (CVV) that is present on VISA, MasterCard,\n and Discover credit and debit cards. For American Express credit or debit cards, the\n CVV is a four-digit numeric code.
\n\n CREDIT_DEBIT_CARD_EXPIRY\n
\nThe expiration date for a credit or debit card. This number is usually four digits\n long and is often formatted as month/year or\n MM/YY. AI Guardrail recognizes expiration dates such as\n 01/21, 01/2021, and Jan\n 2021.
\n\n CREDIT_DEBIT_CARD_NUMBER\n
\nThe number for a credit or debit card. These numbers can vary from 13 to 16 digits\n in length. However, Amazon Comprehend also recognizes credit or debit card numbers\n when only the last four digits are present.
\n\n PIN\n
\nA four-digit personal identification number (PIN) with which you can access your\n bank account.
\n\n INTERNATIONAL_BANK_ACCOUNT_NUMBER\n
\nAn International Bank Account Number has specific formats in each country. For\n more information, see \n www.iban.com/structure.
\n\n SWIFT_CODE\n
\nA SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a\n particular bank or branch. Banks use these codes for money transfers such as\n international wire transfers.
\nSWIFT codes consist of eight or 11 characters. The 11-digit codes refer to\n specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer\n to the head or primary office.
\n\n IT\n
\n\n IP_ADDRESS\n
\nAn IPv4 address, such as 198.51.100.0.
\n\n MAC_ADDRESS\n
\nA media access control (MAC) address is a unique identifier\n assigned to a network interface controller (NIC).
\n\n URL\n
\nA web address, such as www.example.com.
\n\n AWS_ACCESS_KEY\n
\nA unique identifier that's associated with a secret access key; you use the access\n key ID and secret access key to sign programmatic Amazon Web Services requests\n cryptographically.
\n\n AWS_SECRET_KEY\n
\nA unique identifier that's associated with an access key. You use the access key\n ID and secret access key to sign programmatic Amazon Web Services requests\n cryptographically.
\n\n USA specific\n
\n\n US_BANK_ACCOUNT_NUMBER\n
\nA US bank account number, which is typically 10 to 12 digits long.
\n\n US_BANK_ROUTING_NUMBER\n
\nA US bank account routing number. These are typically nine digits long,
\n\n US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER\n
\nA US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that\n starts with a \"9\" and contain a \"7\" or \"8\" as the fourth digit. An ITIN can be\n formatted with a space or a dash after the third and forth digits.
\n\n US_PASSPORT_NUMBER\n
\nA US passport number. Passport numbers range from six to nine alphanumeric\n characters.
\n\n US_SOCIAL_SECURITY_NUMBER\n
\nA US Social Security Number (SSN) is a nine-digit number that is issued to US\n citizens, permanent residents, and temporary working residents.
\n\n Canada specific\n
\n\n CA_HEALTH_NUMBER\n
\nA Canadian Health Service Number is a 10-digit unique identifier, required for\n individuals to access healthcare benefits.
\n\n CA_SOCIAL_INSURANCE_NUMBER\n
\nA Canadian Social Insurance Number (SIN) is a nine-digit unique identifier,\n required for individuals to access government programs and benefits.
\nThe SIN is formatted as three groups of three digits, such as \n 123-456-789. A SIN can be validated through a simple check-digit process\n called the Luhn\n algorithm .
\n\n UK Specific\n
\n\n UK_NATIONAL_HEALTH_SERVICE_NUMBER\n
\nA UK National Health Service Number is a 10-17 digit number, such as 485\n 555 3456. The current system formats the 10-digit number with spaces\n after the third and sixth digits. The final digit is an error-detecting\n checksum.
\n\n UK_NATIONAL_INSURANCE_NUMBER\n
\nA UK National Insurance Number (NINO) provides individuals with access to National\n Insurance (social security) benefits. It is also used for some purposes in the UK tax\n system.
\nThe number is nine digits long and starts with two letters, followed by six\n numbers and one letter. A NINO can be formatted with a space or a dash after the two\n letters and after the second, forth, and sixth digits.
\n\n UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER\n
\nA UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a\n taxpayer or a business.
\n\n Custom\n
\n\n Regex filter - You can use a regular expressions to\n define patterns for an AI Guardrail to recognize and act upon such as serial number,\n booking ID etc..
\nThe association configurations for overriding behavior on this AI Agent.
" } + }, + "locale": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "The locale to which specifies the language and region settings that determine the response\n language for QueryAssistant.
" + } } }, "traits": {