Skip to content

Commit

Permalink
Minor documentation updates to fix links and paragraph formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
jzbruno committed Oct 3, 2020
1 parent 7a0e6d8 commit 58212fa
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 48 deletions.
6 changes: 3 additions & 3 deletions website/docs/r/lex_bot.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The following arguments are supported:
* `enable_model_improvements` - (Optional) Set to `true` to enable access to natural language understanding improvements. When you set the `enable_model_improvements` parameter to true you can use the `nlu_intent_confidence_threshold` parameter to configure confidence scores. For more information, see [Confidence Scores](https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html). You can only set the `enable_model_improvements` parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the [Amazon Lex Bot PutBot API Docs](https://docs.aws.amazon.com/lex/latest/dg/API_PutBot.html#lex-PutBot-request-enableModelImprovements).
* `idle_session_ttl_in_seconds` - (Optional) The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is `300`.
* `locale` - (Optional) Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. For available locales, see [Amazon Lex Bot PutBot API Docs](https://docs.aws.amazon.com/lex/latest/dg/API_PutBot.html#lex-PutBot-request-locale). Default is `en-US`.
* `intent` - (Required) A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under [intent](#intent-1).
* `intent` - (Required) A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under [intent](#intent).
* `name` - (Required) The name of the bot that you want to create, case sensitive.
* `nlu_intent_confidence_threshold` - (Optional) Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot. For more information see [Amazon Lex Bot PutBot API Docs](https://docs.aws.amazon.com/lex/latest/dg/API_PutBot.html#lex-PutBot-request-nluIntentConfidenceThreshold) This value requires `enable_model_improvements` to be set to `true` and the default is `0`.
* `process_behavior` - (Optional) If you set the `process_behavior` element to `BUILD`, Amazon Lex builds the bot so that it can be run. If you set the element to `SAVE` Amazon Lex saves the bot, but doesn't build it. Default is `SAVE`.
Expand Down Expand Up @@ -93,7 +93,7 @@ Lex chooses one of the messages to use to prompt the user.
* `max_attempts` - (Required) The number of times to prompt the user for information.
* `message` - (Required) A set of messages, each of which provides a message string and its type.
You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
Attributes are documented under [message](#message-2).
Attributes are documented under [message](#message).
* `response_card` - (Optional) The response card. Amazon Lex will substitute session attributes and
slot values into the response card. For more information, see
[Example: Using a Response Card](https://docs.aws.amazon.com/lex/latest/dg/ex-resp-card.html).
Expand All @@ -105,7 +105,7 @@ convey information to the user. At runtime, Amazon Lex selects the message to co

* `message` - (Required) A set of messages, each of which provides a message string and its type. You
can specify the message string in plain text or in Speech Synthesis Markup Language (SSML). Attributes
are documented under [message](#message-2).
are documented under [message](#message).
* `response_card` - (Optional) The response card. Amazon Lex will substitute session attributes and
slot values into the response card. For more information, see
[Example: Using a Response Card](https://docs.aws.amazon.com/lex/latest/dg/ex-resp-card.html).
Expand Down
61 changes: 20 additions & 41 deletions website/docs/r/lex_intent.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -119,58 +119,39 @@ resource "aws_lex_intent" "order_flowers_intent" {
The following arguments are supported:

* `conclusion_statement` - (Optional) The statement that you want Amazon Lex to convey to the user
after the intent is successfully fulfilled by the Lambda function.

This element is relevant only if you provide a Lambda function in the `fulfillment_activity`. If you
return the intent to the client application, you can't specify this element.

The `follow_up_prompt` and `conclusion_statement` are mutually exclusive. You can specify only one.

Attributes are documented under [statement](#statement).

after the intent is successfully fulfilled by the Lambda function. This element is relevant only if
you provide a Lambda function in the `fulfillment_activity`. If you return the intent to the client
application, you can't specify this element. The `follow_up_prompt` and `conclusion_statement` are
mutually exclusive. You can specify only one. Attributes are documented under [statement](#statement).
* `confirmation_prompt` - (Optional) Prompts the user to confirm the intent. This question should
have a yes or no answer. You you must provide both the `rejection_statement` and `confirmation_prompt`,
or neither. Attributes are documented under [prompt](#prompt-1).
or neither. Attributes are documented under [prompt](#prompt).
* `create_version` - (Optional) Determines if a new slot type version is created when the initial
resource is created and on each update. Defaults to true.
resource is created and on each update. Defaults to `false`.
* `description` - (Optional) A description of the intent.
* `dialog_code_hook` - (Optional) Specifies a Lambda function to invoke for each user input. You can
invoke this Lambda function to personalize user interaction. Attributes are documented under [code_hook](#code_hook-1).
invoke this Lambda function to personalize user interaction. Attributes are documented under [code_hook](#code_hook).
* `follow_up_prompt` - (Optional) Amazon Lex uses this prompt to solicit additional activity after
fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the
user to order a drink.

The `follow_up_prompt` field and the `conclusion_statement` field are mutually exclusive. You can
specify only one.

Attributes are documented under [follow_up_prompt](#follow_up_prompt-1).

* `fulfillment_activity` - (Optional) Describes how the intent is fulfilled. For example, after a
user to order a drink. The `follow_up_prompt` field and the `conclusion_statement` field are mutually
exclusive. You can specify only one. Attributes are documented under [follow_up_prompt](#follow_up_prompt).
* `fulfillment_activity` - (Required) Describes how the intent is fulfilled. For example, after a
user provides all of the information for a pizza order, `fulfillment_activity` defines how the bot
places an order with a local pizza store.

Attributes are documented under [fulfillment_activity](#fulfillment_activity-1).

places an order with a local pizza store. Attributes are documented under [fulfillment_activity](#fulfillment_activity).
* `name` - (Required) The name of the intent, not case sensitive.
* `parent_intent_signature` - (Optional) A unique identifier for the built-in intent to base this
intent on. To find the signature for an intent, see
[Standard Built-in Intents](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents)
in the Alexa Skills Kit.
* `rejection_statement` - (Optional) When the user answers "no" to the question defined in
`confirmation_prompt`, Amazon Lex responds with this statement to acknowledge that the intent was
canceled.

You must provide both the `rejection_statement` and the `confirmation_prompt`, or neither.

canceled. You must provide both the `rejection_statement` and the `confirmation_prompt`, or neither.
Attributes are documented under [statement](#statement).

* `sample_utterances` - (Optional) An array of utterances (strings) that a user might say to signal
the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".

In each utterance, a slot name is enclosed in curly braces.

* `slot` - (Optional) An list of intent slots. At runtime, Amazon Lex elicits required slot values
from the user using prompts defined in the slots. Attributes are documented under [slot](#slot-1).
from the user using prompts defined in the slots. Attributes are documented under [slot](#slot).

### code_hook

Expand All @@ -186,7 +167,7 @@ to invoke your Lambda function. For more information, see
A prompt for additional activity after an intent is fulfilled. For example, after the OrderPizza
intent is fulfilled, you might prompt the user to find out whether the user wants to order drinks.

* `prompt` - (Required) Prompts for information from the user. Attributes are documented under [prompt](#prompt-1).
* `prompt` - (Required) Prompts for information from the user. Attributes are documented under [prompt](#prompt).
* `rejectionStatement` - (Optional) If the user answers "no" to the question defined in the prompt field,
Amazon Lex responds with this statement to acknowledge that the intent was canceled. Attributes are
documented below under [statement](#statement).
Expand All @@ -198,7 +179,7 @@ Describes how the intent is fulfilled after the user provides all of the informa
* `type` - (Required) How the intent should be fulfilled, either by running a Lambda function or by
returning the slot data to the client application.
* `code_hook` - (Optional) A description of the Lambda function that is run to fulfill the intent.
Required if type is CodeHook. Attributes are documented under [code_hook](#code_hook-1).
Required if type is CodeHook. Attributes are documented under [code_hook](#code_hook).

### message

Expand All @@ -218,7 +199,7 @@ Lex chooses one of the messages to use to prompt the user.
* `max_attempts` - (Required) The number of times to prompt the user for information.
* `message` - (Required) A set of messages, each of which provides a message string and its type.
You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
Attributes are documented under [message](#message-1).
Attributes are documented under [message](#message).
* `response_card` - (Optional) The response card. Amazon Lex will substitute session attributes and
slot values into the response card. For more information, see
[Example: Using a Response Card](https://docs.aws.amazon.com/lex/latest/dg/ex-resp-card.html).
Expand All @@ -232,10 +213,8 @@ Identifies the version of a specific slot.
* `description` - (Optional) A description of the bot.
* `priority` - (Optional) Directs Lex the order in which to elicit this slot value from the user.
For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for
the slot with priority 1.

If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.

the slot with priority 1. If multiple slots share the same priority, the order in which Lex elicits
values is arbitrary.
* `response_card` - (Optional) The response card. Amazon Lex will substitute session attributes and
slot values into the response card. For more information, see
[Example: Using a Response Card](https://docs.aws.amazon.com/lex/latest/dg/ex-resp-card.html).
Expand All @@ -246,7 +225,7 @@ is optional. In most cases, Amazon Lex is capable of understanding user utteranc
the built-in slot types.
* `slot_type_version` - (Optional) The version of the slot type.
* `value_elicitation_prompt` - (Optional) The prompt that Amazon Lex uses to elicit the slot value
from the user. Attributes are documented under [prompt](#prompt-1).
from the user. Attributes are documented under [prompt](#prompt).

### statement

Expand All @@ -255,7 +234,7 @@ convey information to the user. At runtime, Amazon Lex selects the message to co

* `message` - (Required) A set of messages, each of which provides a message string and its type.
You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
Attributes are documented under [message](#message-1).
Attributes are documented under [message](#message).
* `response_card` - (Optional) The response card. Amazon Lex will substitute session attributes and
slot values into the response card. For more information, see
[Example: Using a Response Card](https://docs.aws.amazon.com/lex/latest/dg/ex-resp-card.html).
Expand Down
8 changes: 4 additions & 4 deletions website/docs/r/lex_slot_type.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Provides an Amazon Lex Slot Type resource. For more information see

```hcl
resource "aws_lex_slot_type" "flower_types" {
create_version = false
create_version = true
description = "Types of flowers to order"
enumeration_value {
Expand Down Expand Up @@ -48,16 +48,16 @@ The following arguments are supported:
* `enumeration_value` - (Required) A list of EnumerationValue objects that defines the values that
the slot type can take. Each value can have a list of synonyms, which are additional values that help
train the machine learning model about the values that it resolves for a slot. Attributes are
documented under [enumeration_value](#enumeration_value-1).
documented under [enumeration_value](#enumeration_value).
* `name` - (Required) The name of the slot type. The name is not case sensitive.
* `create_version` - (Optional)
Determines if a new slot type version is created when the initial resource is created and on each
update. Defaults to true.
update. Defaults to `false`.
* `description` - (Optional) A description of the slot type.
* `value_selection_strategy` - (Optional) Determines the slot resolution strategy that Amazon Lex
uses to return slot type values. `ORIGINAL_VALUE` returns the value entered by the user if the user
value is similar to the slot value. `TOP_RESOLUTION` returns the first value in the resolution list
if there is a resolution list for the slot, otherwise null is returned.
if there is a resolution list for the slot, otherwise null is returned. Defaults to `ORIGINAL_VALUE`.

### enumeration_value

Expand Down

0 comments on commit 58212fa

Please sign in to comment.