AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Implementation for accessing Lex
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, .Namespace: Amazon.Lex
Assembly: AWSSDK.Lex.dll
Version: 3.x.y.z
public class AmazonLexClient : AmazonServiceClient IAmazonLex, IAmazonService, IDisposable
The AmazonLexClient type exposes the following members
Name | Description | |
---|---|---|
AmazonLexClient() |
Constructs AmazonLexClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonLexClient(RegionEndpoint) |
Constructs AmazonLexClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonLexClient(AmazonLexConfig) |
Constructs AmazonLexClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonLexClient(AWSCredentials) |
Constructs AmazonLexClient with AWS Credentials |
|
AmazonLexClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonLexClient with AWS Credentials |
|
AmazonLexClient(AWSCredentials, AmazonLexConfig) |
Constructs AmazonLexClient with AWS Credentials and an AmazonLexClient Configuration object. |
|
AmazonLexClient(string, string) |
Constructs AmazonLexClient with AWS Access Key ID and AWS Secret Key |
|
AmazonLexClient(string, string, RegionEndpoint) |
Constructs AmazonLexClient with AWS Access Key ID and AWS Secret Key |
|
AmazonLexClient(string, string, AmazonLexConfig) |
Constructs AmazonLexClient with AWS Access Key ID, AWS Secret Key and an AmazonLexClient Configuration object. |
|
AmazonLexClient(string, string, string) |
Constructs AmazonLexClient with AWS Access Key ID and AWS Secret Key |
|
AmazonLexClient(string, string, string, RegionEndpoint) |
Constructs AmazonLexClient with AWS Access Key ID and AWS Secret Key |
|
AmazonLexClient(string, string, string, AmazonLexConfig) |
Constructs AmazonLexClient with AWS Access Key ID, AWS Secret Key and an AmazonLexClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
Name | Description | |
---|---|---|
DeleteSession(DeleteSessionRequest) |
Removes session information for a specified bot, alias, and user ID. |
|
DeleteSessionAsync(DeleteSessionRequest, CancellationToken) |
Removes session information for a specified bot, alias, and user ID. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
GetSession(GetSessionRequest) |
Returns session information for a specified bot, alias, and user ID. |
|
GetSessionAsync(GetSessionRequest, CancellationToken) |
Returns session information for a specified bot, alias, and user ID. |
|
PostContent(PostContentRequest) |
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 In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:
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
In addition, Amazon Lex also returns your application-specific |
|
PostContentAsync(PostContentRequest, CancellationToken) |
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 In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:
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
In addition, Amazon Lex also returns your application-specific |
|
PostText(PostTextRequest) |
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
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
In addition, Amazon Lex also returns your application-specific |
|
PostTextAsync(PostTextRequest, CancellationToken) |
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
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
In addition, Amazon Lex also returns your application-specific |
|
PutSession(PutSessionRequest) |
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. |
|
PutSessionAsync(PutSessionRequest, CancellationToken) |
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. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5