lexruntimeservice

package
v1.10.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 29, 2017 License: Apache-2.0 Imports: 7 Imported by: 0

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 the client for Amazon Lex Runtime Service you will first need to create a new instance of it.

When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.

Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently. 

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := lexruntimeservice.New(sess)

See the SDK's documentation for more information on how to use service clients. https://docs.aws.amazon.com/sdk-for-go/api/

See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Lex Runtime Service client LexRuntimeService for more information on creating the service's client. https://docs.aws.amazon.com/sdk-for-go/api/service/lexruntimeservice/#New

Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.

The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode". 

result, err := svc.PostContent(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("PostContent result:")
fmt.Println(result)

Using the Client with Context

The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request. 

ctx := context.Background()

result, err := svc.PostContentWithContext(ctx, params)

See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/

Index

Constants

View Source 
const (
	// DialogStateElicitIntent is a DialogState enum value
	DialogStateElicitIntent = "ElicitIntent"

	// DialogStateConfirmIntent is a DialogState enum value
	DialogStateConfirmIntent = "ConfirmIntent"

	// DialogStateElicitSlot is a DialogState enum value
	DialogStateElicitSlot = "ElicitSlot"

	// DialogStateFulfilled is a DialogState enum value
	DialogStateFulfilled = "Fulfilled"

	// DialogStateReadyForFulfillment is a DialogState enum value
	DialogStateReadyForFulfillment = "ReadyForFulfillment"

	// DialogStateFailed is a DialogState enum value
	DialogStateFailed = "Failed"
)
View Source 
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.
	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 downstream 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, it results in Lambda throwing an exception.
	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".
	//
	// Lambda fulfilment function returned DelegateDialogAction to Amazon Lex without
	// changing any slot values.
	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"
)
View Source 
const (
	ServiceName = "runtime.lex" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName   // Service ID for Regions and Endpoints metadata.
)

Service information constants

View Source 
const (
	// ContentTypeApplicationVndAmazonawsCardGeneric is a ContentType enum value
	ContentTypeApplicationVndAmazonawsCardGeneric = "application/vnd.amazonaws.card.generic"
)

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.) Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/Button

func (Button) GoString 

func (s Button) GoString() string

GoString returns the string representation

func (*Button) SetText 

func (s *Button) SetText(v string) *Button

SetText sets the Text field's value.

func (*Button) SetValue 

func (s *Button) SetValue(v string) *Button

SetValue sets the Value field's value.

func (Button) String 

func (s Button) String() string

String returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/GenericAttachment

func (GenericAttachment) GoString 

func (s GenericAttachment) GoString() string

GoString returns the string representation

func (*GenericAttachment) SetAttachmentLinkUrl 

func (s *GenericAttachment) SetAttachmentLinkUrl(v string) *GenericAttachment

SetAttachmentLinkUrl sets the AttachmentLinkUrl field's value.

func (*GenericAttachment) SetButtons 

func (s *GenericAttachment) SetButtons(v []*Button) *GenericAttachment

SetButtons sets the Buttons field's value.

func (*GenericAttachment) SetImageUrl 

func (s *GenericAttachment) SetImageUrl(v string) *GenericAttachment

SetImageUrl sets the ImageUrl field's value.

func (*GenericAttachment) SetSubTitle 

func (s *GenericAttachment) SetSubTitle(v string) *GenericAttachment

SetSubTitle sets the SubTitle field's value.

func (*GenericAttachment) SetTitle 

func (s *GenericAttachment) SetTitle(v string) *GenericAttachment

SetTitle sets the Title field's value.

func (GenericAttachment) String 

func (s GenericAttachment) String() string

String returns the string representation

type LexRuntimeService 

type LexRuntimeService struct {
	*client.Client
}

LexRuntimeService 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.

LexRuntimeService methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *LexRuntimeService

New creates a new instance of the LexRuntimeService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a LexRuntimeService client from just a session.
svc := lexruntimeservice.New(mySession)

// Create a LexRuntimeService client with additional configuration
svc := lexruntimeservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*LexRuntimeService) PostContent added in v1.8.7 

func (c *LexRuntimeService) PostContent(input *PostContentInput) (*PostContentOutput, error)

PostContent API operation for Amazon Lex Runtime Service.

Sends user input (text or speech) to Amazon Lex. Clients use this API to send requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot.

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 (http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lex Runtime Service's API operation PostContent for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.

  • ErrCodeBadRequestException "BadRequestException" Request validation failed, there is no usable message in the context, or the bot build failed.

  • ErrCodeLimitExceededException "LimitExceededException" Exceeded a limit.

  • ErrCodeInternalFailureException "InternalFailureException" Internal service error. Retry the call.

  • ErrCodeConflictException "ConflictException" Two clients are using the same AWS account, Amazon Lex bot, and user ID.

  • ErrCodeUnsupportedMediaTypeException "UnsupportedMediaTypeException" The Content-Type header (PostContent API) has an invalid value.

  • ErrCodeNotAcceptableException "NotAcceptableException" The accept header in the request does not have a valid value.

  • ErrCodeRequestTimeoutException "RequestTimeoutException" The input speech is too long.

  • ErrCodeDependencyFailedException "DependencyFailedException" One of the downstream 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, it results in Lambda throwing an exception.

  • ErrCodeBadGatewayException "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.

  • ErrCodeLoopDetectedException "LoopDetectedException" Lambda fulfilment function returned DelegateDialogAction to Amazon Lex without changing any slot values.

Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostContent

func (*LexRuntimeService) PostContentRequest added in v1.8.7 

func (c *LexRuntimeService) PostContentRequest(input *PostContentInput) (req *request.Request, output *PostContentOutput)

PostContentRequest generates a "aws/request.Request" representing the client's request for the PostContent operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See PostContent for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PostContent method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the PostContentRequest method.
req, resp := client.PostContentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostContent

func (*LexRuntimeService) PostContentWithContext added in v1.8.7 

func (c *LexRuntimeService) PostContentWithContext(ctx aws.Context, input *PostContentInput, opts ...request.Option) (*PostContentOutput, error)

PostContentWithContext is the same as PostContent with the addition of the ability to pass a context and additional request options.

See PostContent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LexRuntimeService) PostText 

func (c *LexRuntimeService) PostText(input *PostTextInput) (*PostTextOutput, error)

PostText API operation for Amazon Lex Runtime Service.

Sends user input (text-only) 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 (http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lex Runtime Service's API operation PostText for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.

  • ErrCodeBadRequestException "BadRequestException" Request validation failed, there is no usable message in the context, or the bot build failed.

  • ErrCodeLimitExceededException "LimitExceededException" Exceeded a limit.

  • ErrCodeInternalFailureException "InternalFailureException" Internal service error. Retry the call.

  • ErrCodeConflictException "ConflictException" Two clients are using the same AWS account, Amazon Lex bot, and user ID.

  • ErrCodeDependencyFailedException "DependencyFailedException" One of the downstream 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, it results in Lambda throwing an exception.

  • ErrCodeBadGatewayException "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.

  • ErrCodeLoopDetectedException "LoopDetectedException" Lambda fulfilment function returned DelegateDialogAction to Amazon Lex without changing any slot values.

Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostText

func (*LexRuntimeService) PostTextRequest 

func (c *LexRuntimeService) PostTextRequest(input *PostTextInput) (req *request.Request, output *PostTextOutput)

PostTextRequest generates a "aws/request.Request" representing the client's request for the PostText operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See PostText for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PostText method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the PostTextRequest method.
req, resp := client.PostTextRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostText

func (*LexRuntimeService) PostTextWithContext added in v1.8.0 

func (c *LexRuntimeService) PostTextWithContext(ctx aws.Context, input *PostTextInput, opts ...request.Option) (*PostTextOutput, error)

PostTextWithContext is the same as PostText with the addition of the ability to pass a context and additional request options.

See PostText for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type PostContentInput added in v1.8.7 

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.
	//
	// 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 values 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/l16; rate=16000; channels=1
	//
	// audio/x-l16; sample-rate=16000; channel-count=1
	//
	//    * Opus format
	//
	// audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=1; frame-size-milliseconds=1.1
	//
	//    * 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.
	//
	// InputStream is a required field
	InputStream io.ReadSeeker `locationName:"inputStream" type:"blob" required:"true"`

	// You pass this value in the x-amz-lex-session-attributes HTTP header. The
	// value must be map (keys and values must be strings) that is JSON serialized
	// and then base64 encoded.
	//
	// A session represents dialog between a user and Amazon Lex. At runtime, a
	// client application can pass contextual information, in the request to Amazon
	// Lex. For example,
	//
	//    * You might use session attributes to track the requestID of user requests.
	//
	//    * In Getting Started Exercise 1, the example bot uses the price session
	//    attribute to maintain the price of flowers ordered (for example, "price":25).
	//    The code hook (Lambda function) sets this attribute based on the type
	//    of flowers ordered. For more information, see Review the Details of Information
	//    Flow (http://docs.aws.amazon.com/lex/latest/dg/gs-bp-details-after-lambda.html).
	//
	//
	//    * In the BookTrip bot exercise, the bot uses the currentReservation session
	//    attribute to maintains the slot data during the in-progress conversation
	//    to book a hotel or book a car. For more information, see Details of Information
	//    Flow (http://docs.aws.amazon.com/lex/latest/dg/book-trip-detail-flow.html).
	//
	//
	// Amazon Lex passes these session attributes to the Lambda functions configured
	// for the intent In the your Lambda function, you can use the session attributes
	// for initialization and customization (prompts). Some examples are:
	//
	//    *  Initialization - In a pizza ordering bot, if you pass user location
	//    (for example, "Location : 111 Maple Street"), then your Lambda function
	//    might use this information to determine the closest pizzeria to place
	//    the order (and perhaps set the storeAddress slot value as well).
	//
	//  Personalized prompts - For example, you can configure prompts to refer to
	//    the user by name (for example, "Hey [firstName], what toppings would you
	//    like?"). You can pass the user's name as a session attribute ("firstName":
	//    "Joe") so that Amazon Lex can substitute the placeholder to provide a
	//    personalized prompt to the user ("Hey Joe, what toppings would you like?").
	//
	//
	// Amazon Lex does not persist session attributes.
	//
	//  If you configured a code hook for the intent, Amazon Lex passes the incoming
	// session attributes to the Lambda function. The Lambda function must return
	// these session attributes if you want Amazon Lex to return them to the client.
	//
	//  If there is no code hook configured for the intent Amazon Lex simply returns
	// the session attributes to the client application.
	SessionAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-session-attributes" type:"jsonvalue"`

	// ID of the client application user. Typically, each of your application users
	// should have a unique ID. The application developer decides the user IDs.
	// At runtime, each request must include the user ID. Note the following considerations:
	//
	//    *  If you want a user to start conversation on one device and continue
	//    the conversation on another device, you might choose a user-specific identifier,
	//    such as the user's login, or Amazon Cognito user ID (assuming your application
	//    is using Amazon Cognito).
	//
	//    *  If you want the same user to be able to have two independent conversations
	//    on two different devices, you might choose device-specific identifier,
	//    such as device ID, or some globally unique identifier.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostContentRequest

func (PostContentInput) GoString added in v1.8.7 

func (s PostContentInput) GoString() string

GoString returns the string representation

func (*PostContentInput) SetAccept added in v1.8.7 

func (s *PostContentInput) SetAccept(v string) *PostContentInput

SetAccept sets the Accept field's value.

func (*PostContentInput) SetBotAlias added in v1.8.7 

func (s *PostContentInput) SetBotAlias(v string) *PostContentInput

SetBotAlias sets the BotAlias field's value.

func (*PostContentInput) SetBotName added in v1.8.7 

func (s *PostContentInput) SetBotName(v string) *PostContentInput

SetBotName sets the BotName field's value.

func (*PostContentInput) SetContentType added in v1.8.7 

func (s *PostContentInput) SetContentType(v string) *PostContentInput

SetContentType sets the ContentType field's value.

func (*PostContentInput) SetInputStream added in v1.8.7 

func (s *PostContentInput) SetInputStream(v io.ReadSeeker) *PostContentInput

SetInputStream sets the InputStream field's value.

func (*PostContentInput) SetSessionAttributes added in v1.8.7 

func (s *PostContentInput) SetSessionAttributes(v aws.JSONValue) *PostContentInput

SetSessionAttributes sets the SessionAttributes field's value.

func (*PostContentInput) SetUserId added in v1.8.7 

func (s *PostContentInput) SetUserId(v string) *PostContentInput

SetUserId sets the UserId field's value.

func (PostContentInput) String added in v1.8.7 

func (s PostContentInput) String() string

String returns the string representation

func (*PostContentInput) Validate added in v1.8.7 

func (s *PostContentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PostContentOutput added in v1.8.7 

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 fullfill 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 *string `location:"header" locationName:"x-amz-lex-dialog-state" type:"string" enum:"DialogState"`

	// Transcript of the voice input to the operation.
	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"`

	// Message to convey to the user. It can come from the bot's configuration or
	// a code hook (Lambda function). If the current intent is not configured with
	// a code hook or if the code hook returned Delegate as the dialogAction.type
	// in its response, then Amazon Lex decides the next course of action and selects
	// an appropriate message from the bot configuration based on the current user
	// interaction context. For example, if Amazon Lex is not able to understand
	// the user input, it uses a clarification prompt message (For more information,
	// see the Error Handling section in the Amazon Lex console). Another example:
	// if the intent requires confirmation before fulfillment, then Amazon Lex uses
	// the confirmation prompt message in the intent configuration. If the code
	// hook returns a message, Amazon Lex passes it as-is in its response to the
	// client.
	Message *string `location:"header" locationName:"x-amz-lex-message" min:"1" type:"string"`

	// 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.
	Slots aws.JSONValue `location:"header" locationName:"x-amz-lex-slots" type:"jsonvalue"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostContentResponse

func (PostContentOutput) GoString added in v1.8.7 

func (s PostContentOutput) GoString() string

GoString returns the string representation

func (*PostContentOutput) SetAudioStream added in v1.8.7 

func (s *PostContentOutput) SetAudioStream(v io.ReadCloser) *PostContentOutput

SetAudioStream sets the AudioStream field's value.

func (*PostContentOutput) SetContentType added in v1.8.7 

func (s *PostContentOutput) SetContentType(v string) *PostContentOutput

SetContentType sets the ContentType field's value.

func (*PostContentOutput) SetDialogState added in v1.8.7 

func (s *PostContentOutput) SetDialogState(v string) *PostContentOutput

SetDialogState sets the DialogState field's value.

func (*PostContentOutput) SetInputTranscript added in v1.8.7 

func (s *PostContentOutput) SetInputTranscript(v string) *PostContentOutput

SetInputTranscript sets the InputTranscript field's value.

func (*PostContentOutput) SetIntentName added in v1.8.7 

func (s *PostContentOutput) SetIntentName(v string) *PostContentOutput

SetIntentName sets the IntentName field's value.

func (*PostContentOutput) SetMessage added in v1.8.7 

func (s *PostContentOutput) SetMessage(v string) *PostContentOutput

SetMessage sets the Message field's value.

func (*PostContentOutput) SetSessionAttributes added in v1.8.7 

func (s *PostContentOutput) SetSessionAttributes(v aws.JSONValue) *PostContentOutput

SetSessionAttributes sets the SessionAttributes field's value.

func (*PostContentOutput) SetSlotToElicit added in v1.8.7 

func (s *PostContentOutput) SetSlotToElicit(v string) *PostContentOutput

SetSlotToElicit sets the SlotToElicit field's value.

func (*PostContentOutput) SetSlots added in v1.8.7 

func (s *PostContentOutput) SetSlots(v aws.JSONValue) *PostContentOutput

SetSlots sets the Slots field's value.

func (PostContentOutput) String added in v1.8.7 

func (s PostContentOutput) String() string

String returns the string representation

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"`

	// By using session attributes, a client application can pass contextual information
	// in the request to Amazon Lex For example,
	//
	//    * In Getting Started Exercise 1, the example bot uses the price session
	//    attribute to maintain the price of the flowers ordered (for example, "Price":25).
	//    The code hook (the Lambda function) sets this attribute based on the type
	//    of flowers ordered. For more information, see Review the Details of Information
	//    Flow (http://docs.aws.amazon.com/lex/latest/dg/gs-bp-details-after-lambda.html).
	//
	//
	//    * In the BookTrip bot exercise, the bot uses the currentReservation session
	//    attribute to maintain slot data during the in-progress conversation to
	//    book a hotel or book a car. For more information, see Details of Information
	//    Flow (http://docs.aws.amazon.com/lex/latest/dg/book-trip-detail-flow.html).
	//
	//
	//    * You might use the session attributes (key, value pairs) to track the
	//    requestID of user requests.
	//
	// Amazon Lex simply passes these session attributes to the Lambda functions
	// configured for the intent.
	//
	// In your Lambda function, you can also use the session attributes for initialization
	// and customization (prompts and response cards). Some examples are:
	//
	//    *  Initialization - In a pizza ordering bot, if you can pass the user
	//    location as a session attribute (for example, "Location" : "111 Maple
	//    street"), then your Lambda function might use this information to determine
	//    the closest pizzeria to place the order (perhaps to set the storeAddress
	//    slot value).
	//
	//    *  Personalize prompts - For example, you can configure prompts to refer
	//    to the user name. (For example, "Hey [FirstName], what toppings would
	//    you like?"). You can pass the user name as a session attribute ("FirstName"
	//    : "Joe") so that Amazon Lex can substitute the placeholder to provide
	//    a personalize prompt to the user ("Hey Joe, what toppings would you like?").
	//
	//
	// Amazon Lex does not persist session attributes.
	//
	//  If you configure a code hook for the intent, Amazon Lex passes the incoming
	// session attributes to the Lambda function. If you want Amazon Lex to return
	// these session attributes back to the client, the Lambda function must return
	// them.
	//
	//  If there is no code hook configured for the intent, Amazon Lex simply returns
	// the session attributes back to the client application.
	SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map"`

	// The ID of the client application user. The application developer decides
	// the user IDs. At runtime, each request must include the user ID. Typically,
	// each of your application users should have a unique ID. Note the following
	// considerations:
	//
	//    *  If you want a user to start a conversation on one device and continue
	//    the conversation on another device, you might choose a user-specific identifier,
	//    such as a login or Amazon Cognito user ID (assuming your application is
	//    using Amazon Cognito).
	//
	//    *  If you want the same user to be able to have two independent conversations
	//    on two different devices, you might choose a device-specific identifier,
	//    such as device ID, or some globally unique identifier.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostTextRequest

func (PostTextInput) GoString 

func (s PostTextInput) GoString() string

GoString returns the string representation

func (*PostTextInput) SetBotAlias 

func (s *PostTextInput) SetBotAlias(v string) *PostTextInput

SetBotAlias sets the BotAlias field's value.

func (*PostTextInput) SetBotName 

func (s *PostTextInput) SetBotName(v string) *PostTextInput

SetBotName sets the BotName field's value.

func (*PostTextInput) SetInputText 

func (s *PostTextInput) SetInputText(v string) *PostTextInput

SetInputText sets the InputText field's value.

func (*PostTextInput) SetSessionAttributes 

func (s *PostTextInput) SetSessionAttributes(v map[string]*string) *PostTextInput

SetSessionAttributes sets the SessionAttributes field's value.

func (*PostTextInput) SetUserId 

func (s *PostTextInput) SetUserId(v string) *PostTextInput

SetUserId sets the UserId field's value.

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 *string `locationName:"dialogState" type:"string" enum:"DialogState"`

	// The current user intent that Amazon Lex is aware of.
	IntentName *string `locationName:"intentName" type:"string"`

	// A message to convey to the user. It can come from the bot's configuration
	// or a code hook (Lambda function). If the current intent is not configured
	// with a code hook or the code hook returned Delegate as the dialogAction.type
	// in its response, then Amazon Lex decides the next course of action and selects
	// an appropriate message from the bot configuration based on the current user
	// interaction context. For example, if Amazon Lex is not able to understand
	// the user input, it uses a clarification prompt message (for more information,
	// see the Error Handling section in the Amazon Lex console). Another example:
	// if the intent requires confirmation before fulfillment, then Amazon Lex uses
	// the confirmation prompt message in the intent configuration. If the code
	// hook returns a message, Amazon Lex passes it as-is in its response to the
	// client.
	Message *string `locationName:"message" min:"1" type:"string"`

	// 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 (name/value pairs) that Amazon Lex detected so far from
	// the user input in the conversation.
	Slots map[string]*string `locationName:"slots" type:"map"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostTextResponse

func (PostTextOutput) GoString 

func (s PostTextOutput) GoString() string

GoString returns the string representation

func (*PostTextOutput) SetDialogState 

func (s *PostTextOutput) SetDialogState(v string) *PostTextOutput

SetDialogState sets the DialogState field's value.

func (*PostTextOutput) SetIntentName 

func (s *PostTextOutput) SetIntentName(v string) *PostTextOutput

SetIntentName sets the IntentName field's value.

func (*PostTextOutput) SetMessage 

func (s *PostTextOutput) SetMessage(v string) *PostTextOutput

SetMessage sets the Message field's value.

func (*PostTextOutput) SetResponseCard 

func (s *PostTextOutput) SetResponseCard(v *ResponseCard) *PostTextOutput

SetResponseCard sets the ResponseCard field's value.

func (*PostTextOutput) SetSessionAttributes 

func (s *PostTextOutput) SetSessionAttributes(v map[string]*string) *PostTextOutput

SetSessionAttributes sets the SessionAttributes field's value.

func (*PostTextOutput) SetSlotToElicit 

func (s *PostTextOutput) SetSlotToElicit(v string) *PostTextOutput

SetSlotToElicit sets the SlotToElicit field's value.

func (*PostTextOutput) SetSlots 

func (s *PostTextOutput) SetSlots(v map[string]*string) *PostTextOutput

SetSlots sets the Slots field's value.

func (PostTextOutput) String 

func (s PostTextOutput) String() string

String returns the string representation

type ResponseCard 

type ResponseCard struct {

	// The content type of the response.
	ContentType *string `locationName:"contentType" type:"string" enum:"ContentType"`

	// 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). Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/ResponseCard

func (ResponseCard) GoString 

func (s ResponseCard) GoString() string

GoString returns the string representation

func (*ResponseCard) SetContentType 

func (s *ResponseCard) SetContentType(v string) *ResponseCard

SetContentType sets the ContentType field's value.

func (*ResponseCard) SetGenericAttachments 

func (s *ResponseCard) SetGenericAttachments(v []*GenericAttachment) *ResponseCard

SetGenericAttachments sets the GenericAttachments field's value.

func (*ResponseCard) SetVersion 

func (s *ResponseCard) SetVersion(v string) *ResponseCard

SetVersion sets the Version field's value.

func (ResponseCard) String 

func (s ResponseCard) String() string

String returns the string representation

Source Files

View all 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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.