Skip to content

Commit

Permalink
r/aws_lexv2models_slot_type(doc): fix argument descriptions, links, a…
Browse files Browse the repository at this point in the history 
…dd missing
  • Loading branch information
@jar-b
jar-b committed Sep 10, 2024
1 parent e2e5b35 commit 50dc809
Showing 1 changed file with 53 additions and 30 deletions.
83 changes: 53 additions & 30 deletions website/docs/r/lexv2models_slot_type.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ resource "aws_lexv2models_bot_version" "test" {
}
}
}
resource "aws_lexv2models_slot_type" "test" {
bot_id = aws_lexv2models_bot.test.id
bot_version = aws_lexv2models_bot_locale.test.bot_version
Expand All @@ -59,71 +60,93 @@ The following arguments are required:

* `bot_id` - (Required) Identifier of the bot associated with this slot type.
* `bot_version` - (Required) Version of the bot associated with this slot type.
* `locale_id` - (Required) Identifier of the language and locale where this slot type is used. All of the bots, slot types, and slots used by the intent must have the same locale.
* `name` - (Required) Name of the slot type
* `locale_id` - (Required) Identifier of the language and locale where this slot type is used.
All of the bots, slot types, and slots used by the intent must have the same locale.
* `name` - (Required) Name of the slot type.

The following arguments are optional:

* `description` - (Optional) Description of the slot type.
* `composite_slot_type_setting` - (Optional) Specifications for a composite slot type. See [`composite_slot_type_setting` argument reference](#composite_slot_type_setting-argument-reference) below.
* `external_source_setting` - (Optional) Type of external information used to create the slot type. See [`external_source_setting` argument reference](#external_source_setting-argument-reference) below.
* `parent_slot_type_signature` - (Optional) Built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type. Only AMAZON.AlphaNumeric is supported.
* `slot_type_values` - (Optional) List of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot. See [`slot_type_values` argument reference](#slot_type_values-argument-reference) below.
* `value_selection_setting` - (Optional) Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values: `ORIGINAL_VALUE` returns the value entered by the user, if the user value is similar to the slot value. `TOP_RESOLUTION` if there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null. If you don't specify the valueSelectionSetting parameter, the default is ORIGINAL_VALUE. See [`value_selection_setting` argument reference](#value_selection_setting-argument-reference) below.
* `composite_slot_type_setting` - (Optional) Specifications for a composite slot type.
See [`composite_slot_type_setting` argument reference](#composite_slot_type_setting-argument-reference) below.
* `external_source_setting` - (Optional) Type of external information used to create the slot type.
See [`external_source_setting` argument reference](#external_source_setting-argument-reference) below.
* `parent_slot_type_signature` - (Optional) Built-in slot type used as a parent of this slot type.
When you define a parent slot type, the new slot type has the configuration of the parent slot type.
Only `AMAZON.AlphaNumeric` is supported.
* `slot_type_values` - (Optional) List of SlotTypeValue objects that defines the values that the slot type can take.
Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.
See [`slot_type_values` argument reference](#slot_type_values-argument-reference) below.
* `value_selection_setting` - (Optional) Determines the strategy that Amazon Lex uses to select a value from the list of possible values.
See [`value_selection_setting` argument reference](#value_selection_setting-argument-reference) below.

### `slot_type_values` Argument Reference
### `composite_slot_type_setting` Argument Reference

* `sample_value` - (Optional) Value of the slot type entry. See [`sample_value` argument reference](#sample_value-argument-reference) below.
* `synonyms` - (Optional) Additional values related to the slot type entry. See [`sample_value` argument reference](#sample_value-argument-reference) below.
* `sub_slots` - (Optional) Sub slots in the composite slot.
See [`sub_slots` argument reference](#sub_slots-argument-reference) below.

### `sample_value` Argument Reference
#### `sub_slots` Argument Reference

* `value` - (Required) Value that can be used for a slot type.
* `name` - (Required) Name of a constituent sub slot inside a composite slot.
* `slot_type_id` - (Required) Unique identifier assigned to a slot type.
This refers to either a built-in slot type or the unique `slot_type_id` of a custom slot type.

### `external_source_setting` Argument Reference

*`grammar_slot_type_setting` - (Optional) Settings required for a slot type based on a grammar that you provide. See [`grammar_slot_type_setting` argument reference](#grammar_slot_type_setting-argument-reference) below.
*`grammar_slot_type_setting` - (Optional) Settings required for a slot type based on a grammar that you provide.
See [`grammar_slot_type_setting` argument reference](#grammar_slot_type_setting-argument-reference) below.

### `grammar_slot_type_setting` Argument Reference
#### `grammar_slot_type_setting` Argument Reference

* `source` - (Optional) Source of the grammar used to create the slot type. See [`grammar_slot_type_source` argument reference](#grammar_slot_type_source-argument-reference) below.
* `source` - (Optional) Source of the grammar used to create the slot type.
See [`source` argument reference](#source-argument-reference) below.

### `grammar_slot_type_source` Argument Reference
##### `source` Argument Reference

* `s3_bucket_name` - (Required) Name of the Amazon S3 bucket that contains the grammar source.
* `s3_object_key` - (Required) Path to the grammar in the Amazon S3 bucket.
* `kms_key_arn` - (Optional) KMS key required to decrypt the contents of the grammar, if any.

### `composite_slot_type_setting` Argument Reference
### `slot_type_values` Argument Reference

* `sub_slots` - (Optional) Subslots in the composite slot. Contains filtered or unexported fields. See [`sub_slot_type_composition` argument reference] below.
* `sample_value` - (Optional) Value of the slot type entry.
See [`sample_value` argument reference](#sample_value-argument-reference) below.
* `synonyms` - (Optional) A list of additional values related to the slot type entry.
See [`synonyms` argument reference](#synonyms-argument-reference) below.

### `sub_slot_type_composition` Argument Reference
#### `sample_value` Argument Reference

* `name` - (Required) Name of a constituent sub slot inside a composite slot.
* `slot_type_id` - (Required) Unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.
* `value` - (Required) Value that can be used for a slot type.

#### `synonyms` Argument Reference

* `value` - (Required) Value that can be used for a slot type.

### `value_selection_setting` Argument Reference

* `resolution_strategy` - (Required) Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values: `ORIGINAL_VALUE` - Returns the value entered by the user, if the user value is similar to the slot value. `TOP_RESOLUTION` If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned. If you don't specify the valueSelectionStrategy , the default is `ORIGINAL_VALUE`. Valid values are `OriginalValue`, `TopResolution`, and `Concatenation`.
* `advanced_recognition_setting` - (Optional) Provides settings that enable advanced recognition settings for slot values. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances. See [`advanced_recognition_setting` argument reference] below.
* `regex_filter` - (Optional) Used to validate the value of the slot. See [`regex_filter` argument reference] below.
* `resolution_strategy` - (Required) Determines the slot resolution strategy that Amazon Lex uses to return slot type values.
Valid values are `OriginalValue`, `TopResolution`, and `Concatenation`.
* `advanced_recognition_setting` - (Optional) Provides settings that enable advanced recognition settings for slot values.
You can use this to enable using slot values as a custom vocabulary for recognizing user utterances.
See [`advanced_recognition_setting` argument reference](#advanced_recognition_setting-argument-reference) below.
* `regex_filter` - (Optional) Used to validate the value of the slot.
See [`regex_filter` argument reference](#regexfilter-argument-reference) below.

### `advanced_recognition_setting` Argument Reference
#### `advanced_recognition_setting` Argument Reference

* `pattern` - (Required) Used to validate the value of a slot. Use a standard regular expression. Amazon Lex supports the following characters in the regular expression: A-Z, a-z, 0-9, Unicode characters ("\⁠u").
Represent Unicode characters with four digits, for example "\⁠u0041" or "\⁠u005A". The following regular expression operators are not supported: Infinite repeaters: *, +, or {x,} with no upper bound, wild card (.)
* `audio_recognition_strategy` - (Optional) Enables using the slot values as a custom vocabulary for recognizing user utterances.
Valid value is `UseSlotValuesAsCustomVocabulary`.

### `advanced_recognition_setting` Argument Reference
#### `regex_filter` Argument Reference

* `audio_recognition_strategy` - (Optional) Enables using the slot values as a custom vocabulary for recognizing user utterances. Valid value is `UseSlotValuesAsCustomVocabulary`.
* `pattern` - (Required) A regular expression used to validate the value of a slot.

## Attribute Reference

This resource exports the following attributes in addition to the arguments above:

* `id` - Comma-delimited string concatenating `bot_id`, `bot_version`, `locale_id`, and `slot_type_id`.
* `slot_id` - Unique identifier for the intent.
* `slot_type_id` - Unique identifier for the slot type.

## Timeouts

Expand Down

0 comments on commit 50dc809

Please sign in to comment.