LexRuntimeService
Service object for interacting with AWS LexRuntimeService service.
public struct LexRuntimeService: AWSService
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, .
Inheritance
AWSService
Initializers
init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the LexRuntimeService client
public init(
client: AWSClient,
region: SotoCore.Region? = nil,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: LexRuntimeService, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
deleteSession(_:logger:on:)
public func deleteSession(_ input: DeleteSessionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteSessionResponse>
Removes session information for a specified bot, alias, and user ID.
getSession(_:logger:on:)
public func getSession(_ input: GetSessionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetSessionResponse>
Returns session information for a specified bot, alias, and user ID.
postContent(_:logger:on:)
public func postContent(_ input: PostContentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PostContentResponse>
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 toElicitSlot
-
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 themessage
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 toConfirmation
and thex-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 toElicitIntent
and thex-amz-slot-to-elicit
header is omitted.
In addition, Amazon Lex also returns your application-specific
sessionAttributes
. For more information, see Managing
Conversation Context.
postText(_:logger:on:)
public func postText(_ input: PostTextRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PostTextResponse>
Sends user input 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 themessage
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 andSlotToElicit
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 andslotToElicit
is set to null.
In addition, Amazon Lex also returns your application-specific
sessionAttributes
. For more information, see Managing
Conversation Context.
putSession(_:logger:on:)
public func putSession(_ input: PutSessionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutSessionResponse>
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.
postContentStreaming(_:logger:on:_:)
public func postContentStreaming(_ input: PostContentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil, _ stream: @escaping (ByteBuffer, EventLoop)->EventLoopFuture<Void>) -> EventLoopFuture<PostContentResponse>
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 toElicitSlot
-
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 themessage
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 toConfirmation
and thex-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 toElicitIntent
and thex-amz-slot-to-elicit
header is omitted.
In addition, Amazon Lex also returns your application-specific
sessionAttributes
. For more information, see Managing
Conversation Context.
putSessionStreaming(_:logger:on:_:)
public func putSessionStreaming(_ input: PutSessionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil, _ stream: @escaping (ByteBuffer, EventLoop)->EventLoopFuture<Void>) -> EventLoopFuture<PutSessionResponse>
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.