Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Series of updates to LexV2 slot type documentation to improve readabilty #39247

Closed
wants to merge 2 commits into from
Closed

Series of updates to LexV2 slot type documentation to improve readabilty #39247

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
edb2a4a
updates to slot type documentation to improve readabilty
breathingdust Sep 10, 2024
46b4ef4
more lex doc updates
breathingdust Sep 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 24 additions & 23 deletions website/docs/r/lexv2models_slot_type.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,57 +65,58 @@ The following arguments are required:
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.
* `composite_slot_type_setting` - (Optional) Specifications for a composite slot type. See [`composite_slot_type_setting`](#composite_slot_type_setting) for more details.
* `external_source_setting` - (Optional) Type of external information used to create the slot type. See [`external_source_setting`](#external_source_setting) for more details.
* `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.
* `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`](#slot_type_values) for more details.
* `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`](#value_selection_setting) for more details.

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

* `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.
* `sample_value` - (Optional) An object containing the value of the slot type entry. See [`sample_value`](#sample_value) for more details.
* `synonyms` - (Optional) A list of additional objects with values related to the slot type entry. See [`synonyms`](#synonyms) for more details.

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

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

### `external_source_setting` Argument Reference
### synonyms

*`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.
* `value` - (Required) Value that can be used for a slot type.

### external_source_setting

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

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

* `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 [`grammar_slot_type_source`](#grammar_slot_type_source) for more details.

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

* `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
### composite_slot_type_setting

* `sub_slots` - (Optional) Subslots in the composite slot. Contains filtered or unexported fields. See [`sub_slot_type_composition` argument reference] below.
* `sub_slots` - (Optional) Subslots in the composite slot. Contains filtered or unexported fields. See [`sub_slot_type_composition`] for more details.

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

* `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_selection_setting` Argument Reference
### value_selection_setting

* `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.
* `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`](#advanced_recognition_setting) for more details.
* `regex_filter` - (Optional) Used to validate the value of the slot. See [`regex_filter`] for more details.

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

* `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 (.)

### `advanced_recognition_setting` Argument Reference

* `audio_recognition_strategy` - (Optional) Enables using the slot values as a custom vocabulary for recognizing user utterances. Valid value is `UseSlotValuesAsCustomVocabulary`.

## Attribute Reference
Expand Down
Loading