Documentation ¶
Overview ¶
Package lexruntimeservice provides the client and types for making API requests to Amazon Lex Runtime Service.
Amazon Lex provides both build and runtime endpoints. Each endpoint provides a set of operations (API). Your conversational bot uses the runtime API to understand user utterances (user input text or voice). For example, suppose a user says "I want pizza", your bot sends this input to Amazon Lex using the runtime API. Amazon Lex recognizes that the user request is for the OrderPizza intent (one of the intents defined in the bot). Then Amazon Lex engages in user conversation on behalf of the bot to elicit required information (slot values, such as pizza size and crust type), and then performs fulfillment activity (that you configured when you created the bot). You use the build-time API to create and manage your Amazon Lex bot. For a list of build-time operations, see the build-time API, .
See https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28 for more information on this service.
See lexruntimeservice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/lexruntimeservice/
Using the Client ¶
To use Amazon Lex Runtime Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon Lex Runtime Service client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/lexruntimeservice/#New
Index ¶
- Constants
- type Button
- type Client
- func (c *Client) DeleteSessionRequest(input *DeleteSessionInput) DeleteSessionRequest
- func (c *Client) GetSessionRequest(input *GetSessionInput) GetSessionRequest
- func (c *Client) PostContentRequest(input *PostContentInput) PostContentRequest
- func (c *Client) PostTextRequest(input *PostTextInput) PostTextRequest
- func (c *Client) PutSessionRequest(input *PutSessionInput) PutSessionRequest
- type ConfirmationStatus
- type ContentType
- type DeleteSessionInput
- type DeleteSessionOutput
- type DeleteSessionRequest
- type DeleteSessionResponse
- type DialogAction
- type DialogActionType
- type DialogState
- type FulfillmentState
- type GenericAttachment
- type GetSessionInput
- type GetSessionOutput
- type GetSessionRequest
- type GetSessionResponse
- type IntentSummary
- type MessageFormatType
- type PostContentInput
- type PostContentOutput
- type PostContentRequest
- type PostContentResponse
- type PostTextInput
- type PostTextOutput
- type PostTextRequest
- type PostTextResponse
- type PutSessionInput
- type PutSessionOutput
- type PutSessionRequest
- type PutSessionResponse
- type ResponseCard
Constants ¶
const ( ServiceName = "Amazon Lex Runtime Service" // Service's name ServiceID = "LexRuntimeService" // Service's identifier EndpointsID = "runtime.lex" // Service's Endpoint identifier )
const ( // ErrCodeBadGatewayException for service response error code // "BadGatewayException". // // Either the Amazon Lex bot is still building, or one of the dependent services // (Amazon Polly, AWS Lambda) failed with an internal service error. ErrCodeBadGatewayException = "BadGatewayException" // ErrCodeBadRequestException for service response error code // "BadRequestException". // // Request validation failed, there is no usable message in the context, or // the bot build failed, is still in progress, or contains unbuilt changes. ErrCodeBadRequestException = "BadRequestException" // ErrCodeConflictException for service response error code // "ConflictException". // // Two clients are using the same AWS account, Amazon Lex bot, and user ID. ErrCodeConflictException = "ConflictException" // ErrCodeDependencyFailedException for service response error code // "DependencyFailedException". // // One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. // For example, // // * If Amazon Lex does not have sufficient permissions to call a Lambda // function. // // * If a Lambda function takes longer than 30 seconds to execute. // // * If a fulfillment Lambda function returns a Delegate dialog action without // removing any slot values. ErrCodeDependencyFailedException = "DependencyFailedException" // ErrCodeInternalFailureException for service response error code // "InternalFailureException". // // Internal service error. Retry the call. ErrCodeInternalFailureException = "InternalFailureException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // Exceeded a limit. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeLoopDetectedException for service response error code // "LoopDetectedException". // // This exception is not used. ErrCodeLoopDetectedException = "LoopDetectedException" // ErrCodeNotAcceptableException for service response error code // "NotAcceptableException". // // The accept header in the request does not have a valid value. ErrCodeNotAcceptableException = "NotAcceptableException" // ErrCodeNotFoundException for service response error code // "NotFoundException". // // The resource (such as the Amazon Lex bot or an alias) that is referred to // is not found. ErrCodeNotFoundException = "NotFoundException" // ErrCodeRequestTimeoutException for service response error code // "RequestTimeoutException". // // The input speech is too long. ErrCodeRequestTimeoutException = "RequestTimeoutException" // ErrCodeUnsupportedMediaTypeException for service response error code // "UnsupportedMediaTypeException". // // The Content-Type header (PostContent API) has an invalid value. ErrCodeUnsupportedMediaTypeException = "UnsupportedMediaTypeException" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Button ¶
type Button struct { // Text that is visible to the user on the button. // // Text is a required field Text *string `locationName:"text" min:"1" type:"string" required:"true"` // The value sent to Amazon Lex when a user chooses the button. For example, // consider button text "NYC." When the user chooses the button, the value sent // can be "New York City." // // Value is a required field Value *string `locationName:"value" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents an option to be shown on the client platform (Facebook, Slack, etc.)
func (Button) MarshalFields ¶ added in v0.3.0
func (s Button) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to Amazon Lex Runtime Service. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := lexruntimeservice.New(myConfig)
func (*Client) DeleteSessionRequest ¶ added in v0.11.0
func (c *Client) DeleteSessionRequest(input *DeleteSessionInput) DeleteSessionRequest
DeleteSessionRequest returns a request value for making API operation for Amazon Lex Runtime Service.
Removes session information for a specified bot, alias, and user ID.
// Example sending a request using DeleteSessionRequest. req := client.DeleteSessionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/DeleteSession
func (*Client) GetSessionRequest ¶ added in v0.11.0
func (c *Client) GetSessionRequest(input *GetSessionInput) GetSessionRequest
GetSessionRequest returns a request value for making API operation for Amazon Lex Runtime Service.
Returns session information for a specified bot, alias, and user ID.
// Example sending a request using GetSessionRequest. req := client.GetSessionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/GetSession
func (*Client) PostContentRequest ¶ added in v0.9.0
func (c *Client) PostContentRequest(input *PostContentInput) PostContentRequest
PostContentRequest returns a request value for making API operation for Amazon Lex Runtime Service.
Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot.
The PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications.
In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:
For a user input "I would like a pizza," Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?".
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: "Order the pizza?".
After the user replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the message, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information: x-amz-lex-dialog-state header set to ElicitSlot x-amz-lex-intent-name header set to the intent name in the current context x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting information x-amz-lex-slots header set to a map of slots configured for the intent with their current values
If the message is a confirmation prompt, the x-amz-lex-dialog-state header is set to Confirmation and the x-amz-lex-slot-to-elicit header is omitted.
If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the x-amz-dialog-state header is set to ElicitIntent and the x-amz-slot-to-elicit header is omitted.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html).
// Example sending a request using PostContentRequest. req := client.PostContentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostContent
func (*Client) PostTextRequest ¶ added in v0.9.0
func (c *Client) PostTextRequest(input *PostTextInput) PostTextRequest
PostTextRequest returns a request value for making API operation for Amazon Lex Runtime Service.
Sends user input (text or SSML) to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot.
In response, Amazon Lex returns the next message to convey to the user an optional responseCard to display. Consider the following example messages:
For a user input "I would like a pizza", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?"
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation "Proceed with the pizza order?".
After the user replies to a confirmation prompt with a "yes", Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a "yes" or "no" user response. In addition to the message, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the slotToElicit, dialogState, intentName, and slots fields in the response. Consider the following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information: dialogState set to ElicitSlot intentName set to the intent name in the current context slotToElicit set to the slot name for which the message is eliciting information slots set to a map of slots, configured for the intent, with currently known values
If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and SlotToElicit is set to null.
If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the dialogState is set to ElicitIntent and slotToElicit is set to null.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html).
// Example sending a request using PostTextRequest. req := client.PostTextRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostText
func (*Client) PutSessionRequest ¶ added in v0.11.0
func (c *Client) PutSessionRequest(input *PutSessionInput) PutSessionRequest
PutSessionRequest returns a request value for making API operation for Amazon Lex Runtime Service.
Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
For more information, see Managing Sessions (https://docs.aws.amazon.com/lex/latest/dg/how-session-api.html).
// Example sending a request using PutSessionRequest. req := client.PutSessionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PutSession
type ConfirmationStatus ¶ added in v0.11.0
type ConfirmationStatus string
const ( ConfirmationStatusNone ConfirmationStatus = "None" ConfirmationStatusConfirmed ConfirmationStatus = "Confirmed" ConfirmationStatusDenied ConfirmationStatus = "Denied" )
Enum values for ConfirmationStatus
func (ConfirmationStatus) MarshalValue ¶ added in v0.11.0
func (enum ConfirmationStatus) MarshalValue() (string, error)
func (ConfirmationStatus) MarshalValueBuf ¶ added in v0.11.0
func (enum ConfirmationStatus) MarshalValueBuf(b []byte) ([]byte, error)
type ContentType ¶
type ContentType string
const (
ContentTypeApplicationVndAmazonawsCardGeneric ContentType = "application/vnd.amazonaws.card.generic"
)
Enum values for ContentType
func (ContentType) MarshalValue ¶ added in v0.3.0
func (enum ContentType) MarshalValue() (string, error)
func (ContentType) MarshalValueBuf ¶ added in v0.3.0
func (enum ContentType) MarshalValueBuf(b []byte) ([]byte, error)
type DeleteSessionInput ¶ added in v0.11.0
type DeleteSessionInput struct { // The alias in use for the bot that contains the session data. // // BotAlias is a required field BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"` // The name of the bot that contains the session data. // // BotName is a required field BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"` // The identifier of the user associated with the session data. // // UserId is a required field UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteSessionInput) MarshalFields ¶ added in v0.11.0
func (s DeleteSessionInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteSessionInput) String ¶ added in v0.11.0
func (s DeleteSessionInput) String() string
String returns the string representation
func (*DeleteSessionInput) Validate ¶ added in v0.11.0
func (s *DeleteSessionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteSessionOutput ¶ added in v0.11.0
type DeleteSessionOutput struct { // The alias in use for the bot associated with the session data. BotAlias *string `locationName:"botAlias" type:"string"` // The name of the bot associated with the session data. BotName *string `locationName:"botName" type:"string"` // The unique identifier for the session. SessionId *string `locationName:"sessionId" type:"string"` // The ID of the client application user. UserId *string `locationName:"userId" min:"2" type:"string"` // contains filtered or unexported fields }
func (DeleteSessionOutput) MarshalFields ¶ added in v0.11.0
func (s DeleteSessionOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteSessionOutput) String ¶ added in v0.11.0
func (s DeleteSessionOutput) String() string
String returns the string representation
type DeleteSessionRequest ¶ added in v0.11.0
type DeleteSessionRequest struct { *aws.Request Input *DeleteSessionInput Copy func(*DeleteSessionInput) DeleteSessionRequest }
DeleteSessionRequest is the request type for the DeleteSession API operation.
func (DeleteSessionRequest) Send ¶ added in v0.11.0
func (r DeleteSessionRequest) Send(ctx context.Context) (*DeleteSessionResponse, error)
Send marshals and sends the DeleteSession API request.
type DeleteSessionResponse ¶ added in v0.11.0
type DeleteSessionResponse struct { *DeleteSessionOutput // contains filtered or unexported fields }
DeleteSessionResponse is the response type for the DeleteSession API operation.
func (*DeleteSessionResponse) SDKResponseMetdata ¶ added in v0.11.0
func (r *DeleteSessionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteSession request.
type DialogAction ¶ added in v0.11.0
type DialogAction struct { // The fulfillment state of the intent. The possible values are: // // * Failed - The Lambda function associated with the intent failed to fulfill // the intent. // // * Fulfilled - The intent has fulfilled by the Lambda function associated // with the intent. // // * ReadyForFulfillment - All of the information necessary for the intent // is present and the intent ready to be fulfilled by the client application. FulfillmentState FulfillmentState `locationName:"fulfillmentState" type:"string" enum:"true"` // The name of the intent. IntentName *string `locationName:"intentName" type:"string"` // The message that should be shown to the user. If you don't specify a message, // Amazon Lex will use the message configured for the intent. Message *string `locationName:"message" min:"1" type:"string"` // * PlainText - The message contains plain UTF-8 text. // // * CustomPayload - The message is a custom format for the client. // // * SSML - The message contains text formatted for voice output. // // * Composite - The message contains an escaped JSON object containing one // or more messages. For more information, see Message Groups (https://docs.aws.amazon.com/lex/latest/dg/howitworks-manage-prompts.html). MessageFormat MessageFormatType `locationName:"messageFormat" type:"string" enum:"true"` // The name of the slot that should be elicited from the user. SlotToElicit *string `locationName:"slotToElicit" type:"string"` // Map of the slots that have been gathered and their values. Slots map[string]string `locationName:"slots" type:"map"` // The next action that the bot should take in its interaction with the user. // The possible values are: // // * ConfirmIntent - The next action is asking the user if the intent is // complete and ready to be fulfilled. This is a yes/no question such as // "Place the order?" // // * Close - Indicates that the there will not be a response from the user. // For example, the statement "Your order has been placed" does not require // a response. // // * Delegate - The next action is determined by Amazon Lex. // // * ElicitIntent - The next action is to determine the intent that the user // wants to fulfill. // // * ElicitSlot - The next action is to elicit a slot value from the user. // // Type is a required field Type DialogActionType `locationName:"type" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Describes the next action that the bot should take in its interaction with the user and provides information about the context in which the action takes place. Use the DialogAction data type to set the interaction to a specific state, or to return the interaction to a previous state.
func (DialogAction) MarshalFields ¶ added in v0.11.0
func (s DialogAction) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DialogAction) String ¶ added in v0.11.0
func (s DialogAction) String() string
String returns the string representation
func (*DialogAction) Validate ¶ added in v0.11.0
func (s *DialogAction) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DialogActionType ¶ added in v0.11.0
type DialogActionType string
const ( DialogActionTypeElicitIntent DialogActionType = "ElicitIntent" DialogActionTypeConfirmIntent DialogActionType = "ConfirmIntent" DialogActionTypeElicitSlot DialogActionType = "ElicitSlot" DialogActionTypeClose DialogActionType = "Close" DialogActionTypeDelegate DialogActionType = "Delegate" )
Enum values for DialogActionType
func (DialogActionType) MarshalValue ¶ added in v0.11.0
func (enum DialogActionType) MarshalValue() (string, error)
func (DialogActionType) MarshalValueBuf ¶ added in v0.11.0
func (enum DialogActionType) MarshalValueBuf(b []byte) ([]byte, error)
type DialogState ¶
type DialogState string
const ( DialogStateElicitIntent DialogState = "ElicitIntent" DialogStateConfirmIntent DialogState = "ConfirmIntent" DialogStateElicitSlot DialogState = "ElicitSlot" DialogStateFulfilled DialogState = "Fulfilled" DialogStateReadyForFulfillment DialogState = "ReadyForFulfillment" DialogStateFailed DialogState = "Failed" )
Enum values for DialogState
func (DialogState) MarshalValue ¶ added in v0.3.0
func (enum DialogState) MarshalValue() (string, error)
func (DialogState) MarshalValueBuf ¶ added in v0.3.0
func (enum DialogState) MarshalValueBuf(b []byte) ([]byte, error)
type FulfillmentState ¶ added in v0.11.0
type FulfillmentState string
const ( FulfillmentStateFulfilled FulfillmentState = "Fulfilled" FulfillmentStateFailed FulfillmentState = "Failed" FulfillmentStateReadyForFulfillment FulfillmentState = "ReadyForFulfillment" )
Enum values for FulfillmentState
func (FulfillmentState) MarshalValue ¶ added in v0.11.0
func (enum FulfillmentState) MarshalValue() (string, error)
func (FulfillmentState) MarshalValueBuf ¶ added in v0.11.0
func (enum FulfillmentState) MarshalValueBuf(b []byte) ([]byte, error)
type GenericAttachment ¶
type GenericAttachment struct { // The URL of an attachment to the response card. AttachmentLinkUrl *string `locationName:"attachmentLinkUrl" min:"1" type:"string"` // The list of options to show to the user. Buttons []Button `locationName:"buttons" type:"list"` // The URL of an image that is displayed to the user. ImageUrl *string `locationName:"imageUrl" min:"1" type:"string"` // The subtitle shown below the title. SubTitle *string `locationName:"subTitle" min:"1" type:"string"` // The title of the option. Title *string `locationName:"title" min:"1" type:"string"` // contains filtered or unexported fields }
Represents an option rendered to the user when a prompt is shown. It could be an image, a button, a link, or text.
func (GenericAttachment) MarshalFields ¶ added in v0.3.0
func (s GenericAttachment) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GenericAttachment) String ¶
func (s GenericAttachment) String() string
String returns the string representation
type GetSessionInput ¶ added in v0.11.0
type GetSessionInput struct { // The alias in use for the bot that contains the session data. // // BotAlias is a required field BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"` // The name of the bot that contains the session data. // // BotName is a required field BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"` // The ID of the client application user. Amazon Lex uses this to identify a // user's conversation with your bot. // // UserId is a required field UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetSessionInput) MarshalFields ¶ added in v0.11.0
func (s GetSessionInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetSessionInput) String ¶ added in v0.11.0
func (s GetSessionInput) String() string
String returns the string representation
func (*GetSessionInput) Validate ¶ added in v0.11.0
func (s *GetSessionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSessionOutput ¶ added in v0.11.0
type GetSessionOutput struct { // Describes the current state of the bot. DialogAction *DialogAction `locationName:"dialogAction" type:"structure"` // An array of information about the intents used in the session. The array // can contain a maximum of three summaries. If more than three intents are // used in the session, the recentIntentSummaryView operation contains information // about the last three intents used. RecentIntentSummaryView []IntentSummary `locationName:"recentIntentSummaryView" type:"list"` // Map of key/value pairs representing the session-specific context information. // It contains application information passed between Amazon Lex and a client // application. SessionAttributes map[string]string `locationName:"sessionAttributes" type:"map"` // A unique identifier for the session. SessionId *string `locationName:"sessionId" type:"string"` // contains filtered or unexported fields }
func (GetSessionOutput) MarshalFields ¶ added in v0.11.0
func (s GetSessionOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetSessionOutput) String ¶ added in v0.11.0
func (s GetSessionOutput) String() string
String returns the string representation
type GetSessionRequest ¶ added in v0.11.0
type GetSessionRequest struct { *aws.Request Input *GetSessionInput Copy func(*GetSessionInput) GetSessionRequest }
GetSessionRequest is the request type for the GetSession API operation.
func (GetSessionRequest) Send ¶ added in v0.11.0
func (r GetSessionRequest) Send(ctx context.Context) (*GetSessionResponse, error)
Send marshals and sends the GetSession API request.
type GetSessionResponse ¶ added in v0.11.0
type GetSessionResponse struct { *GetSessionOutput // contains filtered or unexported fields }
GetSessionResponse is the response type for the GetSession API operation.
func (*GetSessionResponse) SDKResponseMetdata ¶ added in v0.11.0
func (r *GetSessionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetSession request.
type IntentSummary ¶ added in v0.11.0
type IntentSummary struct { // The status of the intent after the user responds to the confirmation prompt. // If the user confirms the intent, Amazon Lex sets this field to Confirmed. // If the user denies the intent, Amazon Lex sets this value to Denied. The // possible values are: // // * Confirmed - The user has responded "Yes" to the confirmation prompt, // confirming that the intent is complete and that it is ready to be fulfilled. // // * Denied - The user has responded "No" to the confirmation prompt. // // * None - The user has never been prompted for confirmation; or, the user // was prompted but did not confirm or deny the prompt. ConfirmationStatus ConfirmationStatus `locationName:"confirmationStatus" type:"string" enum:"true"` // The next action that the bot should take in its interaction with the user. // The possible values are: // // * ConfirmIntent - The next action is asking the user if the intent is // complete and ready to be fulfilled. This is a yes/no question such as // "Place the order?" // // * Close - Indicates that the there will not be a response from the user. // For example, the statement "Your order has been placed" does not require // a response. // // * ElicitIntent - The next action is to determine the intent that the user // wants to fulfill. // // * ElicitSlot - The next action is to elicit a slot value from the user. // // DialogActionType is a required field DialogActionType DialogActionType `locationName:"dialogActionType" type:"string" required:"true" enum:"true"` // The fulfillment state of the intent. The possible values are: // // * Failed - The Lambda function associated with the intent failed to fulfill // the intent. // // * Fulfilled - The intent has fulfilled by the Lambda function associated // with the intent. // // * ReadyForFulfillment - All of the information necessary for the intent // is present and the intent ready to be fulfilled by the client application. FulfillmentState FulfillmentState `locationName:"fulfillmentState" type:"string" enum:"true"` // The name of the intent. IntentName *string `locationName:"intentName" type:"string"` // The next slot to elicit from the user. If there is not slot to elicit, the // field is blank. SlotToElicit *string `locationName:"slotToElicit" type:"string"` // Map of the slots that have been gathered and their values. Slots map[string]string `locationName:"slots" type:"map"` // contains filtered or unexported fields }
Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its previous state.
func (IntentSummary) MarshalFields ¶ added in v0.11.0
func (s IntentSummary) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (IntentSummary) String ¶ added in v0.11.0
func (s IntentSummary) String() string
String returns the string representation
type MessageFormatType ¶ added in v0.3.0
type MessageFormatType string
const ( MessageFormatTypePlainText MessageFormatType = "PlainText" MessageFormatTypeCustomPayload MessageFormatType = "CustomPayload" MessageFormatTypeSsml MessageFormatType = "SSML" MessageFormatTypeComposite MessageFormatType = "Composite" )
Enum values for MessageFormatType
func (MessageFormatType) MarshalValue ¶ added in v0.3.0
func (enum MessageFormatType) MarshalValue() (string, error)
func (MessageFormatType) MarshalValueBuf ¶ added in v0.3.0
func (enum MessageFormatType) MarshalValueBuf(b []byte) ([]byte, error)
type PostContentInput ¶
type PostContentInput struct { // You pass this value as the Accept HTTP header. // // The message Amazon Lex returns in the response can be either text or speech // based on the Accept HTTP header value in the request. // // * If the value is text/plain; charset=utf-8, Amazon Lex returns text in // the response. // // * If the value begins with audio/, Amazon Lex returns speech in the response. // Amazon Lex uses Amazon Polly to generate the speech (using the configuration // you specified in the Accept header). For example, if you specify audio/mpeg // as the value, Amazon Lex returns speech in the MPEG format. // // * If the value is audio/pcm, the speech returned is audio/pcm in 16-bit, // little endian format. // // * The following are the accepted values: audio/mpeg audio/ogg audio/pcm // text/plain; charset=utf-8 audio/* (defaults to mpeg) Accept *string `location:"header" locationName:"Accept" type:"string"` // Alias of the Amazon Lex bot. // // BotAlias is a required field BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"` // Name of the Amazon Lex bot. // // BotName is a required field BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"` // You pass this value as the Content-Type HTTP header. // // Indicates the audio format or text. The header value must start with one // of the following prefixes: // // * PCM format, audio data must be in little-endian byte order. audio/l16; // rate=16000; channels=1 audio/x-l16; sample-rate=16000; channel-count=1 // audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false // // * Opus format audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; // frame-size-milliseconds=4 // // * Text format text/plain; charset=utf-8 // // ContentType is a required field ContentType *string `location:"header" locationName:"Content-Type" type:"string" required:"true"` // User input in PCM or Opus audio format or text format as described in the // Content-Type HTTP header. // // You can stream audio data to Amazon Lex or you can create a local buffer // that captures all of the audio data before sending. In general, you get better // performance if you stream audio data rather than buffering the data locally. // // To use an non-seekable io.Reader for this request wrap the io.Reader with // "aws.ReadSeekCloser". The SDK will not retry request errors for non-seekable // readers. This will allow the SDK to send the reader's payload as chunked // transfer encoding. // // InputStream is a required field InputStream io.ReadSeeker `locationName:"inputStream" type:"blob" required:"true"` // You pass this value as the x-amz-lex-request-attributes HTTP header. // // Request-specific information passed between Amazon Lex and a client application. // The value must be a JSON serialized and base64 encoded map with string keys // and values. The total size of the requestAttributes and sessionAttributes // headers is limited to 12 KB. // // The namespace x-amz-lex: is reserved for special attributes. Don't create // any request attributes with the prefix x-amz-lex:. // // For more information, see Setting Request Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs). RequestAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-request-attributes" type:"jsonvalue"` // You pass this value as the x-amz-lex-session-attributes HTTP header. // // Application-specific information passed between Amazon Lex and a client application. // The value must be a JSON serialized and base64 encoded map with string keys // and values. The total size of the sessionAttributes and requestAttributes // headers is limited to 12 KB. // // For more information, see Setting Session Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs). SessionAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-session-attributes" type:"jsonvalue"` // The ID of the client application user. Amazon Lex uses this to identify a // user's conversation with your bot. At runtime, each request must contain // the userID field. // // To decide the user ID to use for your application, consider the following // factors. // // * The userID field must not contain any personally identifiable information // of the user, for example, name, personal identification numbers, or other // end user personal information. // // * If you want a user to start a conversation on one device and continue // on another device, use a user-specific identifier. // // * If you want the same user to be able to have two independent conversations // on two different devices, choose a device-specific identifier. // // * A user can't have two independent conversations with two different versions // of the same bot. For example, a user can't have a conversation with the // PROD and BETA versions of the same bot. If you anticipate that a user // will need to have conversation with two different versions, for example, // while testing, include the bot alias in the user ID to separate the two // conversations. // // UserId is a required field UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"` // contains filtered or unexported fields }
func (PostContentInput) MarshalFields ¶ added in v0.3.0
func (s PostContentInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PostContentInput) String ¶
func (s PostContentInput) String() string
String returns the string representation
func (*PostContentInput) Validate ¶
func (s *PostContentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PostContentOutput ¶
type PostContentOutput struct { // The prompt (or statement) to convey to the user. This is based on the bot // configuration and context. For example, if Amazon Lex did not understand // the user intent, it sends the clarificationPrompt configured for the bot. // If the intent requires confirmation before taking the fulfillment action, // it sends the confirmationPrompt. Another example: Suppose that the Lambda // function successfully fulfilled the intent, and sent a message to convey // to the user. Then Amazon Lex sends that message in the response. AudioStream io.ReadCloser `locationName:"audioStream" type:"blob"` // Content type as specified in the Accept HTTP header in the request. ContentType *string `location:"header" locationName:"Content-Type" type:"string"` // Identifies the current state of the user interaction. Amazon Lex returns // one of the following values as dialogState. The client can optionally use // this information to customize the user interface. // // * ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider // the following examples: For example, a user might utter an intent ("I // want to order a pizza"). If Amazon Lex cannot infer the user intent from // this utterance, it will return this dialog state. // // * ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response. For // example, Amazon Lex wants user confirmation before fulfilling an intent. // Instead of a simple "yes" or "no" response, a user might respond with // additional information. For example, "yes, but make it a thick crust pizza" // or "no, I want to order a drink." Amazon Lex can process such additional // information (in these examples, update the crust type slot or change the // intent from OrderPizza to OrderDrink). // // * ElicitSlot - Amazon Lex is expecting the value of a slot for the current // intent. For example, suppose that in the response Amazon Lex sends this // message: "What size pizza would you like?". A user might reply with the // slot value (e.g., "medium"). The user might also provide additional information // in the response (e.g., "medium thick crust pizza"). Amazon Lex can process // such additional information appropriately. // // * Fulfilled - Conveys that the Lambda function has successfully fulfilled // the intent. // // * ReadyForFulfillment - Conveys that the client has to fulfill the request. // // * Failed - Conveys that the conversation with the user failed. This can // happen for various reasons, including that the user does not provide an // appropriate response to prompts from the service (you can configure how // many times Amazon Lex can prompt a user for specific information), or // if the Lambda function fails to fulfill the intent. DialogState DialogState `location:"header" locationName:"x-amz-lex-dialog-state" type:"string" enum:"true"` // The text used to process the request. // // If the input was an audio stream, the inputTranscript field contains the // text extracted from the audio stream. This is the text that is actually processed // to recognize intents and slot values. You can use this information to determine // if Amazon Lex is correctly processing the audio that you send. InputTranscript *string `location:"header" locationName:"x-amz-lex-input-transcript" type:"string"` // Current user intent that Amazon Lex is aware of. IntentName *string `location:"header" locationName:"x-amz-lex-intent-name" type:"string"` // The message to convey to the user. The message can come from the bot's configuration // or from a Lambda function. // // If the intent is not configured with a Lambda function, or if the Lambda // function returned Delegate as the dialogAction.type in its response, Amazon // Lex decides on the next course of action and selects an appropriate message // from the bot's configuration based on the current interaction context. For // example, if Amazon Lex isn't able to understand user input, it uses a clarification // prompt message. // // When you create an intent you can assign messages to groups. When messages // are assigned to groups Amazon Lex returns one message from each group in // the response. The message field is an escaped JSON string containing the // messages. For more information about the structure of the JSON string returned, // see msg-prompts-formats. // // If the Lambda function returns a message, Amazon Lex passes it to the client // in its response. Message *string `location:"header" locationName:"x-amz-lex-message" min:"1" type:"string"` // The format of the response message. One of the following values: // // * PlainText - The message contains plain UTF-8 text. // // * CustomPayload - The message is a custom format for the client. // // * SSML - The message contains text formatted for voice output. // // * Composite - The message contains an escaped JSON object containing one // or more messages from the groups that messages were assigned to when the // intent was created. MessageFormat MessageFormatType `location:"header" locationName:"x-amz-lex-message-format" type:"string" enum:"true"` // Map of key/value pairs representing the session-specific context information. SessionAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-session-attributes" type:"jsonvalue"` // If the dialogState value is ElicitSlot, returns the name of the slot for // which Amazon Lex is eliciting a value. SlotToElicit *string `location:"header" locationName:"x-amz-lex-slot-to-elicit" type:"string"` // Map of zero or more intent slots (name/value pairs) Amazon Lex detected from // the user input during the conversation. The field is base-64 encoded. // // Amazon Lex creates a resolution list containing likely values for a slot. // The value that it returns is determined by the valueSelectionStrategy selected // when the slot type was created or updated. If valueSelectionStrategy is set // to ORIGINAL_VALUE, the value provided by the user is returned, if the user // value is similar to the slot values. If valueSelectionStrategy is set to // TOP_RESOLUTION Amazon Lex returns the first value in the resolution list // or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, // the default is ORIGINAL_VALUE. Slots aws.JSONValue `location:"header" locationName:"x-amz-lex-slots" type:"jsonvalue"` // contains filtered or unexported fields }
func (PostContentOutput) MarshalFields ¶ added in v0.3.0
func (s PostContentOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PostContentOutput) String ¶
func (s PostContentOutput) String() string
String returns the string representation
type PostContentRequest ¶
type PostContentRequest struct { *aws.Request Input *PostContentInput Copy func(*PostContentInput) PostContentRequest }
PostContentRequest is the request type for the PostContent API operation.
func (PostContentRequest) Send ¶
func (r PostContentRequest) Send(ctx context.Context) (*PostContentResponse, error)
Send marshals and sends the PostContent API request.
type PostContentResponse ¶ added in v0.9.0
type PostContentResponse struct { *PostContentOutput // contains filtered or unexported fields }
PostContentResponse is the response type for the PostContent API operation.
func (*PostContentResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PostContentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PostContent request.
type PostTextInput ¶
type PostTextInput struct { // The alias of the Amazon Lex bot. // // BotAlias is a required field BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"` // The name of the Amazon Lex bot. // // BotName is a required field BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"` // The text that the user entered (Amazon Lex interprets this text). // // InputText is a required field InputText *string `locationName:"inputText" min:"1" type:"string" required:"true"` // Request-specific information passed between Amazon Lex and a client application. // // The namespace x-amz-lex: is reserved for special attributes. Don't create // any request attributes with the prefix x-amz-lex:. // // For more information, see Setting Request Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs). RequestAttributes map[string]string `locationName:"requestAttributes" type:"map"` // Application-specific information passed between Amazon Lex and a client application. // // For more information, see Setting Session Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs). SessionAttributes map[string]string `locationName:"sessionAttributes" type:"map"` // The ID of the client application user. Amazon Lex uses this to identify a // user's conversation with your bot. At runtime, each request must contain // the userID field. // // To decide the user ID to use for your application, consider the following // factors. // // * The userID field must not contain any personally identifiable information // of the user, for example, name, personal identification numbers, or other // end user personal information. // // * If you want a user to start a conversation on one device and continue // on another device, use a user-specific identifier. // // * If you want the same user to be able to have two independent conversations // on two different devices, choose a device-specific identifier. // // * A user can't have two independent conversations with two different versions // of the same bot. For example, a user can't have a conversation with the // PROD and BETA versions of the same bot. If you anticipate that a user // will need to have conversation with two different versions, for example, // while testing, include the bot alias in the user ID to separate the two // conversations. // // UserId is a required field UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"` // contains filtered or unexported fields }
func (PostTextInput) MarshalFields ¶ added in v0.3.0
func (s PostTextInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PostTextInput) String ¶
func (s PostTextInput) String() string
String returns the string representation
func (*PostTextInput) Validate ¶
func (s *PostTextInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PostTextOutput ¶
type PostTextOutput struct { // Identifies the current state of the user interaction. Amazon Lex returns // one of the following values as dialogState. The client can optionally use // this information to customize the user interface. // // * ElicitIntent - Amazon Lex wants to elicit user intent. For example, // a user might utter an intent ("I want to order a pizza"). If Amazon Lex // cannot infer the user intent from this utterance, it will return this // dialogState. // // * ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response. For // example, Amazon Lex wants user confirmation before fulfilling an intent. // Instead of a simple "yes" or "no," a user might respond with additional // information. For example, "yes, but make it thick crust pizza" or "no, // I want to order a drink". Amazon Lex can process such additional information // (in these examples, update the crust type slot value, or change intent // from OrderPizza to OrderDrink). // // * ElicitSlot - Amazon Lex is expecting a slot value for the current intent. // For example, suppose that in the response Amazon Lex sends this message: // "What size pizza would you like?". A user might reply with the slot value // (e.g., "medium"). The user might also provide additional information in // the response (e.g., "medium thick crust pizza"). Amazon Lex can process // such additional information appropriately. // // * Fulfilled - Conveys that the Lambda function configured for the intent // has successfully fulfilled the intent. // // * ReadyForFulfillment - Conveys that the client has to fulfill the intent. // // * Failed - Conveys that the conversation with the user failed. This can // happen for various reasons including that the user did not provide an // appropriate response to prompts from the service (you can configure how // many times Amazon Lex can prompt a user for specific information), or // the Lambda function failed to fulfill the intent. DialogState DialogState `locationName:"dialogState" type:"string" enum:"true"` // The current user intent that Amazon Lex is aware of. IntentName *string `locationName:"intentName" type:"string"` // The message to convey to the user. The message can come from the bot's configuration // or from a Lambda function. // // If the intent is not configured with a Lambda function, or if the Lambda // function returned Delegate as the dialogAction.type its response, Amazon // Lex decides on the next course of action and selects an appropriate message // from the bot's configuration based on the current interaction context. For // example, if Amazon Lex isn't able to understand user input, it uses a clarification // prompt message. // // When you create an intent you can assign messages to groups. When messages // are assigned to groups Amazon Lex returns one message from each group in // the response. The message field is an escaped JSON string containing the // messages. For more information about the structure of the JSON string returned, // see msg-prompts-formats. // // If the Lambda function returns a message, Amazon Lex passes it to the client // in its response. Message *string `locationName:"message" min:"1" type:"string"` // The format of the response message. One of the following values: // // * PlainText - The message contains plain UTF-8 text. // // * CustomPayload - The message is a custom format defined by the Lambda // function. // // * SSML - The message contains text formatted for voice output. // // * Composite - The message contains an escaped JSON object containing one // or more messages from the groups that messages were assigned to when the // intent was created. MessageFormat MessageFormatType `locationName:"messageFormat" type:"string" enum:"true"` // Represents the options that the user has to respond to the current prompt. // Response Card can come from the bot configuration (in the Amazon Lex console, // choose the settings button next to a slot) or from a code hook (Lambda function). ResponseCard *ResponseCard `locationName:"responseCard" type:"structure"` // A map of key-value pairs representing the session-specific context information. SessionAttributes map[string]string `locationName:"sessionAttributes" type:"map"` // If the dialogState value is ElicitSlot, returns the name of the slot for // which Amazon Lex is eliciting a value. SlotToElicit *string `locationName:"slotToElicit" type:"string"` // The intent slots that Amazon Lex detected from the user input in the conversation. // // Amazon Lex creates a resolution list containing likely values for a slot. // The value that it returns is determined by the valueSelectionStrategy selected // when the slot type was created or updated. If valueSelectionStrategy is set // to ORIGINAL_VALUE, the value provided by the user is returned, if the user // value is similar to the slot values. If valueSelectionStrategy is set to // TOP_RESOLUTION Amazon Lex returns the first value in the resolution list // or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, // the default is ORIGINAL_VALUE. Slots map[string]string `locationName:"slots" type:"map"` // contains filtered or unexported fields }
func (PostTextOutput) MarshalFields ¶ added in v0.3.0
func (s PostTextOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PostTextOutput) String ¶
func (s PostTextOutput) String() string
String returns the string representation
type PostTextRequest ¶
type PostTextRequest struct { *aws.Request Input *PostTextInput Copy func(*PostTextInput) PostTextRequest }
PostTextRequest is the request type for the PostText API operation.
func (PostTextRequest) Send ¶
func (r PostTextRequest) Send(ctx context.Context) (*PostTextResponse, error)
Send marshals and sends the PostText API request.
type PostTextResponse ¶ added in v0.9.0
type PostTextResponse struct { *PostTextOutput // contains filtered or unexported fields }
PostTextResponse is the response type for the PostText API operation.
func (*PostTextResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PostTextResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PostText request.
type PutSessionInput ¶ added in v0.11.0
type PutSessionInput struct { // The message that Amazon Lex returns in the response can be either text or // speech based depending on the value of this field. // // * If the value is text/plain; charset=utf-8, Amazon Lex returns text in // the response. // // * If the value begins with audio/, Amazon Lex returns speech in the response. // Amazon Lex uses Amazon Polly to generate the speech in the configuration // that you specify. For example, if you specify audio/mpeg as the value, // Amazon Lex returns speech in the MPEG format. // // * If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, // little endian format. // // * The following are the accepted values: audio/mpeg audio/ogg audio/pcm // audio/* (defaults to mpeg) text/plain; charset=utf-8 Accept *string `location:"header" locationName:"Accept" type:"string"` // The alias in use for the bot that contains the session data. // // BotAlias is a required field BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"` // The name of the bot that contains the session data. // // BotName is a required field BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"` // Sets the next action that the bot should take to fulfill the conversation. DialogAction *DialogAction `locationName:"dialogAction" type:"structure"` // Map of key/value pairs representing the session-specific context information. // It contains application information passed between Amazon Lex and a client // application. SessionAttributes map[string]string `locationName:"sessionAttributes" type:"map"` // The ID of the client application user. Amazon Lex uses this to identify a // user's conversation with your bot. // // UserId is a required field UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"` // contains filtered or unexported fields }
func (PutSessionInput) MarshalFields ¶ added in v0.11.0
func (s PutSessionInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutSessionInput) String ¶ added in v0.11.0
func (s PutSessionInput) String() string
String returns the string representation
func (*PutSessionInput) Validate ¶ added in v0.11.0
func (s *PutSessionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutSessionOutput ¶ added in v0.11.0
type PutSessionOutput struct { // The audio version of the message to convey to the user. AudioStream io.ReadCloser `locationName:"audioStream" type:"blob"` // Content type as specified in the Accept HTTP header in the request. ContentType *string `location:"header" locationName:"Content-Type" type:"string"` // * ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to // confirm the intent before fulfilling an intent. // // * ElicitIntent - Amazon Lex wants to elicit the user's intent. // // * ElicitSlot - Amazon Lex is expecting the value of a slot for the current // intent. // // * Failed - Conveys that the conversation with the user has failed. This // can happen for various reasons, including the user does not provide an // appropriate response to prompts from the service, or if the Lambda function // fails to fulfill the intent. // // * Fulfilled - Conveys that the Lambda function has sucessfully fulfilled // the intent. // // * ReadyForFulfillment - Conveys that the client has to fulfill the intent. DialogState DialogState `location:"header" locationName:"x-amz-lex-dialog-state" type:"string" enum:"true"` // The name of the current intent. IntentName *string `location:"header" locationName:"x-amz-lex-intent-name" type:"string"` // The next message that should be presented to the user. Message *string `location:"header" locationName:"x-amz-lex-message" min:"1" type:"string"` // The format of the response message. One of the following values: // // * PlainText - The message contains plain UTF-8 text. // // * CustomPayload - The message is a custom format for the client. // // * SSML - The message contains text formatted for voice output. // // * Composite - The message contains an escaped JSON object containing one // or more messages from the groups that messages were assigned to when the // intent was created. MessageFormat MessageFormatType `location:"header" locationName:"x-amz-lex-message-format" type:"string" enum:"true"` // Map of key/value pairs representing session-specific context information. SessionAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-session-attributes" type:"jsonvalue"` // A unique identifier for the session. SessionId *string `location:"header" locationName:"x-amz-lex-session-id" type:"string"` // If the dialogState is ElicitSlot, returns the name of the slot for which // Amazon Lex is eliciting a value. SlotToElicit *string `location:"header" locationName:"x-amz-lex-slot-to-elicit" type:"string"` // Map of zero or more intent slots Amazon Lex detected from the user input // during the conversation. // // Amazon Lex creates a resolution list containing likely values for a slot. // The value that it returns is determined by the valueSelectionStrategy selected // when the slot type was created or updated. If valueSelectionStrategy is set // to ORIGINAL_VALUE, the value provided by the user is returned, if the user // value is similar to the slot values. If valueSelectionStrategy is set to // TOP_RESOLUTION Amazon Lex returns the first value in the resolution list // or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy // the default is ORIGINAL_VALUE. Slots aws.JSONValue `location:"header" locationName:"x-amz-lex-slots" type:"jsonvalue"` // contains filtered or unexported fields }
func (PutSessionOutput) MarshalFields ¶ added in v0.11.0
func (s PutSessionOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutSessionOutput) String ¶ added in v0.11.0
func (s PutSessionOutput) String() string
String returns the string representation
type PutSessionRequest ¶ added in v0.11.0
type PutSessionRequest struct { *aws.Request Input *PutSessionInput Copy func(*PutSessionInput) PutSessionRequest }
PutSessionRequest is the request type for the PutSession API operation.
func (PutSessionRequest) Send ¶ added in v0.11.0
func (r PutSessionRequest) Send(ctx context.Context) (*PutSessionResponse, error)
Send marshals and sends the PutSession API request.
type PutSessionResponse ¶ added in v0.11.0
type PutSessionResponse struct { *PutSessionOutput // contains filtered or unexported fields }
PutSessionResponse is the response type for the PutSession API operation.
func (*PutSessionResponse) SDKResponseMetdata ¶ added in v0.11.0
func (r *PutSessionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutSession request.
type ResponseCard ¶
type ResponseCard struct { // The content type of the response. ContentType ContentType `locationName:"contentType" type:"string" enum:"true"` // An array of attachment objects representing options. GenericAttachments []GenericAttachment `locationName:"genericAttachments" type:"list"` // The version of the response card format. Version *string `locationName:"version" type:"string"` // contains filtered or unexported fields }
If you configure a response card when creating your bots, Amazon Lex substitutes the session attributes and slot values that are available, and then returns it. The response card can also come from a Lambda function ( dialogCodeHook and fulfillmentActivity on an intent).
func (ResponseCard) MarshalFields ¶ added in v0.3.0
func (s ResponseCard) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ResponseCard) String ¶
func (s ResponseCard) String() string
String returns the string representation
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package lexruntimeserviceiface provides an interface to enable mocking the Amazon Lex Runtime Service service client for testing your code.
|
Package lexruntimeserviceiface provides an interface to enable mocking the Amazon Lex Runtime Service service client for testing your code. |