/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the runtime.lex-2016-11-28.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.Lex.Model; namespace Amazon.Lex { /// /// Interface 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, . /// public partial interface IAmazonLex : IAmazonService, IDisposable { #region DeleteSession /// /// Removes session information for a specified bot, alias, and user ID. /// /// Container for the necessary parameters to execute the DeleteSession service method. /// /// The response from the DeleteSession service method, as returned by Lex. /// /// Request validation failed, there is no usable message in the context, or the bot /// build failed, is still in progress, or contains unbuilt changes. /// /// /// Two clients are using the same AWS account, Amazon Lex bot, and user ID. /// /// /// Internal service error. Retry the call. /// /// /// Exceeded a limit. /// /// /// The resource (such as the Amazon Lex bot or an alias) that is referred to is not found. /// /// REST API Reference for DeleteSession Operation DeleteSessionResponse DeleteSession(DeleteSessionRequest request); /// /// Initiates the asynchronous execution of the DeleteSession operation. /// /// /// Container for the necessary parameters to execute the DeleteSession operation on AmazonLexClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSession /// operation. /// REST API Reference for DeleteSession Operation IAsyncResult BeginDeleteSession(DeleteSessionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteSession operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteSession. /// /// Returns a DeleteSessionResult from Lex. /// REST API Reference for DeleteSession Operation DeleteSessionResponse EndDeleteSession(IAsyncResult asyncResult); #endregion #region GetSession /// /// Returns session information for a specified bot, alias, and user ID. /// /// Container for the necessary parameters to execute the GetSession service method. /// /// The response from the GetSession service method, as returned by Lex. /// /// Request validation failed, there is no usable message in the context, or the bot /// build failed, is still in progress, or contains unbuilt changes. /// /// /// Internal service error. Retry the call. /// /// /// Exceeded a limit. /// /// /// The resource (such as the Amazon Lex bot or an alias) that is referred to is not found. /// /// REST API Reference for GetSession Operation GetSessionResponse GetSession(GetSessionRequest request); /// /// Initiates the asynchronous execution of the GetSession operation. /// /// /// Container for the necessary parameters to execute the GetSession operation on AmazonLexClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSession /// operation. /// REST API Reference for GetSession Operation IAsyncResult BeginGetSession(GetSessionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetSession operation. /// /// /// The IAsyncResult returned by the call to BeginGetSession. /// /// Returns a GetSessionResult from Lex. /// REST API Reference for GetSession Operation GetSessionResponse EndGetSession(IAsyncResult asyncResult); #endregion #region PostContent /// /// 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: /// /// /// /// 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: /// /// /// /// In addition, Amazon Lex also returns your application-specific sessionAttributes. /// For more information, see Managing /// Conversation Context. /// /// /// Container for the necessary parameters to execute the PostContent service method. /// /// The response from the PostContent service method, as returned by Lex. /// /// Either the Amazon Lex bot is still building, or one of the dependent services (Amazon /// Polly, AWS Lambda) failed with an internal service error. /// /// /// Request validation failed, there is no usable message in the context, or the bot /// build failed, is still in progress, or contains unbuilt changes. /// /// /// Two clients are using the same AWS account, Amazon Lex bot, and user ID. /// /// /// One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. /// For example, /// /// /// /// /// Internal service error. Retry the call. /// /// /// Exceeded a limit. /// /// /// This exception is not used. /// /// /// The accept header in the request does not have a valid value. /// /// /// The resource (such as the Amazon Lex bot or an alias) that is referred to is not found. /// /// /// The input speech is too long. /// /// /// The Content-Type header (PostContent API) has an invalid value. /// /// REST API Reference for PostContent Operation PostContentResponse PostContent(PostContentRequest request); /// /// Initiates the asynchronous execution of the PostContent operation. /// /// /// Container for the necessary parameters to execute the PostContent operation on AmazonLexClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPostContent /// operation. /// REST API Reference for PostContent Operation IAsyncResult BeginPostContent(PostContentRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the PostContent operation. /// /// /// The IAsyncResult returned by the call to BeginPostContent. /// /// Returns a PostContentResult from Lex. /// REST API Reference for PostContent Operation PostContentResponse EndPostContent(IAsyncResult asyncResult); #endregion #region PostText /// /// 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: /// /// /// /// /// 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: /// /// /// /// In addition, Amazon Lex also returns your application-specific sessionAttributes. /// For more information, see Managing /// Conversation Context. /// /// /// Container for the necessary parameters to execute the PostText service method. /// /// The response from the PostText service method, as returned by Lex. /// /// Either the Amazon Lex bot is still building, or one of the dependent services (Amazon /// Polly, AWS Lambda) failed with an internal service error. /// /// /// Request validation failed, there is no usable message in the context, or the bot /// build failed, is still in progress, or contains unbuilt changes. /// /// /// Two clients are using the same AWS account, Amazon Lex bot, and user ID. /// /// /// One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. /// For example, /// /// /// /// /// Internal service error. Retry the call. /// /// /// Exceeded a limit. /// /// /// This exception is not used. /// /// /// The resource (such as the Amazon Lex bot or an alias) that is referred to is not found. /// /// REST API Reference for PostText Operation PostTextResponse PostText(PostTextRequest request); /// /// Initiates the asynchronous execution of the PostText operation. /// /// /// Container for the necessary parameters to execute the PostText operation on AmazonLexClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPostText /// operation. /// REST API Reference for PostText Operation IAsyncResult BeginPostText(PostTextRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the PostText operation. /// /// /// The IAsyncResult returned by the call to BeginPostText. /// /// Returns a PostTextResult from Lex. /// REST API Reference for PostText Operation PostTextResponse EndPostText(IAsyncResult asyncResult); #endregion #region PutSession /// /// 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. /// /// /// Container for the necessary parameters to execute the PutSession service method. /// /// The response from the PutSession service method, as returned by Lex. /// /// Either the Amazon Lex bot is still building, or one of the dependent services (Amazon /// Polly, AWS Lambda) failed with an internal service error. /// /// /// Request validation failed, there is no usable message in the context, or the bot /// build failed, is still in progress, or contains unbuilt changes. /// /// /// Two clients are using the same AWS account, Amazon Lex bot, and user ID. /// /// /// One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. /// For example, /// /// /// /// /// Internal service error. Retry the call. /// /// /// Exceeded a limit. /// /// /// The accept header in the request does not have a valid value. /// /// /// The resource (such as the Amazon Lex bot or an alias) that is referred to is not found. /// /// REST API Reference for PutSession Operation PutSessionResponse PutSession(PutSessionRequest request); /// /// Initiates the asynchronous execution of the PutSession operation. /// /// /// Container for the necessary parameters to execute the PutSession operation on AmazonLexClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutSession /// operation. /// REST API Reference for PutSession Operation IAsyncResult BeginPutSession(PutSessionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the PutSession operation. /// /// /// The IAsyncResult returned by the call to BeginPutSession. /// /// Returns a PutSessionResult from Lex. /// REST API Reference for PutSession Operation PutSessionResponse EndPutSession(IAsyncResult asyncResult); #endregion } }