/*******************************************************************************
* Copyright 2012-2019 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.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.Lex;
using Amazon.Lex.Model;
namespace Amazon.PowerShell.Cmdlets.LEX
{
///
/// 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.
///
///
[Cmdlet("Send", "LEXContent")]
[OutputType("Amazon.Lex.Model.PostContentResponse")]
[AWSCmdlet("Calls the Amazon Lex PostContent API operation.", Operation = new[] {"PostContent"}, SelectReturnType = typeof(Amazon.Lex.Model.PostContentResponse))]
[AWSCmdletOutput("Amazon.Lex.Model.PostContentResponse",
"This cmdlet returns an Amazon.Lex.Model.PostContentResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class SendLEXContentCmdlet : AmazonLexClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
protected override bool IsSensitiveResponse { get; set; } = true;
#region Parameter Accept
///
///
/// 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)
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Accept { get; set; }
#endregion
#region Parameter ActiveContext
///
///
/// A list of contexts active for the request. A context can be activated when a previous
/// intent is fulfilled, or by including the context in the request,If you don't specify a list of contexts, Amazon Lex will use the current list of contexts
/// for the session. If you specify an empty list, all contexts for the session are cleared.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ActiveContexts")]
public System.String ActiveContext { get; set; }
#endregion
#region Parameter BotAlias
///
///
/// Alias of the Amazon Lex bot.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String BotAlias { get; set; }
#endregion
#region Parameter BotName
///
///
/// Name of the Amazon Lex bot.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String BotName { get; set; }
#endregion
#region Parameter ContentType
///
///
/// 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
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String ContentType { get; set; }
#endregion
#region Parameter InputStream
///
///
/// 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.
///
/// The cmdlet accepts a parameter of type string, string[], System.IO.FileInfo or System.IO.Stream.
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public object InputStream { get; set; }
#endregion
#region Parameter RequestAttribute
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("RequestAttributes")]
public System.String RequestAttribute { get; set; }
#endregion
#region Parameter SessionAttribute
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("SessionAttributes")]
public System.String SessionAttribute { get; set; }
#endregion
#region Parameter UserId
///
///
/// 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.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String UserId { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lex.Model.PostContentResponse).
/// Specifying the name of a property of type Amazon.Lex.Model.PostContentResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "*";
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.Accept = this.Accept;
context.ActiveContext = this.ActiveContext;
context.BotAlias = this.BotAlias;
#if MODULAR
if (this.BotAlias == null && ParameterWasBound(nameof(this.BotAlias)))
{
WriteWarning("You are passing $null as a value for parameter BotAlias which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.BotName = this.BotName;
#if MODULAR
if (this.BotName == null && ParameterWasBound(nameof(this.BotName)))
{
WriteWarning("You are passing $null as a value for parameter BotName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.ContentType = this.ContentType;
#if MODULAR
if (this.ContentType == null && ParameterWasBound(nameof(this.ContentType)))
{
WriteWarning("You are passing $null as a value for parameter ContentType which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.InputStream = this.InputStream;
#if MODULAR
if (this.InputStream == null && ParameterWasBound(nameof(this.InputStream)))
{
WriteWarning("You are passing $null as a value for parameter InputStream which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.RequestAttribute = this.RequestAttribute;
context.SessionAttribute = this.SessionAttribute;
context.UserId = this.UserId;
#if MODULAR
if (this.UserId == null && ParameterWasBound(nameof(this.UserId)))
{
WriteWarning("You are passing $null as a value for parameter UserId which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
System.IO.Stream _InputStreamStream = null;
try
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.Lex.Model.PostContentRequest();
if (cmdletContext.Accept != null)
{
request.Accept = cmdletContext.Accept;
}
if (cmdletContext.ActiveContext != null)
{
request.ActiveContexts = cmdletContext.ActiveContext;
}
if (cmdletContext.BotAlias != null)
{
request.BotAlias = cmdletContext.BotAlias;
}
if (cmdletContext.BotName != null)
{
request.BotName = cmdletContext.BotName;
}
if (cmdletContext.ContentType != null)
{
request.ContentType = cmdletContext.ContentType;
}
if (cmdletContext.InputStream != null)
{
_InputStreamStream = Amazon.PowerShell.Common.StreamParameterConverter.TransformToStream(cmdletContext.InputStream);
request.InputStream = _InputStreamStream;
}
if (cmdletContext.RequestAttribute != null)
{
request.RequestAttributes = cmdletContext.RequestAttribute;
}
if (cmdletContext.SessionAttribute != null)
{
request.SessionAttributes = cmdletContext.SessionAttribute;
}
if (cmdletContext.UserId != null)
{
request.UserId = cmdletContext.UserId;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
finally
{
if( _InputStreamStream != null)
{
_InputStreamStream.Dispose();
}
}
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.Lex.Model.PostContentResponse CallAWSServiceOperation(IAmazonLex client, Amazon.Lex.Model.PostContentRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lex", "PostContent");
try
{
#if DESKTOP
return client.PostContent(request);
#elif CORECLR
return client.PostContentAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.String Accept { get; set; }
public System.String ActiveContext { get; set; }
public System.String BotAlias { get; set; }
public System.String BotName { get; set; }
public System.String ContentType { get; set; }
public object InputStream { get; set; }
public System.String RequestAttribute { get; set; }
public System.String SessionAttribute { get; set; }
public System.String UserId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}