lexruntimeservice

package
v1.38.60 Latest Latest
Warning

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

 Go to latest Published: Jun 11, 2021 License: Apache-2.0 Imports: 10 Imported by: 25

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 contact Amazon Lex Runtime Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

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

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

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

Index

Constants

View Source 
const (
	// ConfirmationStatusNone is a ConfirmationStatus enum value
	ConfirmationStatusNone = "None"

	// ConfirmationStatusConfirmed is a ConfirmationStatus enum value
	ConfirmationStatusConfirmed = "Confirmed"

	// ConfirmationStatusDenied is a ConfirmationStatus enum value
	ConfirmationStatusDenied = "Denied"
)
View Source 
const (
	// DialogActionTypeElicitIntent is a DialogActionType enum value
	DialogActionTypeElicitIntent = "ElicitIntent"

	// DialogActionTypeConfirmIntent is a DialogActionType enum value
	DialogActionTypeConfirmIntent = "ConfirmIntent"

	// DialogActionTypeElicitSlot is a DialogActionType enum value
	DialogActionTypeElicitSlot = "ElicitSlot"

	// DialogActionTypeClose is a DialogActionType enum value
	DialogActionTypeClose = "Close"

	// DialogActionTypeDelegate is a DialogActionType enum value
	DialogActionTypeDelegate = "Delegate"
)
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 (
	// FulfillmentStateFulfilled is a FulfillmentState enum value
	FulfillmentStateFulfilled = "Fulfilled"

	// FulfillmentStateFailed is a FulfillmentState enum value
	FulfillmentStateFailed = "Failed"

	// FulfillmentStateReadyForFulfillment is a FulfillmentState enum value
	FulfillmentStateReadyForFulfillment = "ReadyForFulfillment"
)
View Source 
const (
	// MessageFormatTypePlainText is a MessageFormatType enum value
	MessageFormatTypePlainText = "PlainText"

	// MessageFormatTypeCustomPayload is a MessageFormatType enum value
	MessageFormatTypeCustomPayload = "CustomPayload"

	// MessageFormatTypeSsml is a MessageFormatType enum value
	MessageFormatTypeSsml = "SSML"

	// MessageFormatTypeComposite is a MessageFormatType enum value
	MessageFormatTypeComposite = "Composite"
)
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, is still in progress, or contains unbuilt changes.
	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 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.
	//
	//    * If a Lambda function takes longer than 30 seconds to execute.
	//
	//    * If a fulfillment Lambda function returns a Delegate dialog action without
	//    removing any slot values.
	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".
	//
	// This exception is not used.
	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"         // Name of service.
	EndpointsID = ServiceName           // ID to lookup a service endpoint with.
	ServiceID   = "Lex Runtime Service" // ServiceID is a unique identifier of a specific service.
)

Service information constants

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

Variables

This section is empty.

Functions

func ConfirmationStatus_Values added in v1.34.3 

func ConfirmationStatus_Values() []string

ConfirmationStatus_Values returns all elements of the ConfirmationStatus enum

func ContentType_Values added in v1.34.3 

func ContentType_Values() []string

ContentType_Values returns all elements of the ContentType enum

func DialogActionType_Values added in v1.34.3 

func DialogActionType_Values() []string

DialogActionType_Values returns all elements of the DialogActionType enum

func DialogState_Values added in v1.34.3 

func DialogState_Values() []string

DialogState_Values returns all elements of the DialogState enum

func FulfillmentState_Values added in v1.34.3 

func FulfillmentState_Values() []string

FulfillmentState_Values returns all elements of the FulfillmentState enum

func MessageFormatType_Values added in v1.34.3 

func MessageFormatType_Values() []string

MessageFormatType_Values returns all elements of the MessageFormatType enum

Types

type ActiveContext added in v1.35.32 

type ActiveContext struct {

	// The name of the context.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// State variables for the current context. You can use these values as default
	// values for slots in subsequent events.
	//
	// Parameters is a required field
	Parameters map[string]*string `locationName:"parameters" type:"map" required:"true"`

	// The length of time or number of turns that a context remains active.
	//
	// TimeToLive is a required field
	TimeToLive *ActiveContextTimeToLive `locationName:"timeToLive" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A context is a variable that contains information about the current state of the conversation between a user and Amazon Lex. Context can be set automatically by Amazon Lex when an intent is fulfilled, or it can be set at runtime using the PutContent, PutText, or PutSession operation.

func (ActiveContext) GoString added in v1.35.32 

func (s ActiveContext) GoString() string

GoString returns the string representation

func (*ActiveContext) SetName added in v1.35.32 

func (s *ActiveContext) SetName(v string) *ActiveContext

SetName sets the Name field's value.

func (*ActiveContext) SetParameters added in v1.35.32 

func (s *ActiveContext) SetParameters(v map[string]*string) *ActiveContext

SetParameters sets the Parameters field's value.

func (*ActiveContext) SetTimeToLive added in v1.35.32 

func (s *ActiveContext) SetTimeToLive(v *ActiveContextTimeToLive) *ActiveContext

SetTimeToLive sets the TimeToLive field's value.

func (ActiveContext) String added in v1.35.32 

func (s ActiveContext) String() string

String returns the string representation

func (*ActiveContext) Validate added in v1.35.32 

func (s *ActiveContext) Validate() error

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

type ActiveContextTimeToLive added in v1.35.32 

type ActiveContextTimeToLive struct {

	// The number of seconds that the context should be active after it is first
	// sent in a PostContent or PostText response. You can set the value between
	// 5 and 86,400 seconds (24 hours).
	TimeToLiveInSeconds *int64 `locationName:"timeToLiveInSeconds" min:"5" type:"integer"`

	// The number of conversation turns that the context should be active. A conversation
	// turn is one PostContent or PostText request and the corresponding response
	// from Amazon Lex.
	TurnsToLive *int64 `locationName:"turnsToLive" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The length of time or number of turns that a context remains active.

func (ActiveContextTimeToLive) GoString added in v1.35.32 

func (s ActiveContextTimeToLive) GoString() string

GoString returns the string representation

func (*ActiveContextTimeToLive) SetTimeToLiveInSeconds added in v1.35.32 

func (s *ActiveContextTimeToLive) SetTimeToLiveInSeconds(v int64) *ActiveContextTimeToLive

SetTimeToLiveInSeconds sets the TimeToLiveInSeconds field's value.

func (*ActiveContextTimeToLive) SetTurnsToLive added in v1.35.32 

func (s *ActiveContextTimeToLive) SetTurnsToLive(v int64) *ActiveContextTimeToLive

SetTurnsToLive sets the TurnsToLive field's value.

func (ActiveContextTimeToLive) String added in v1.35.32 

func (s ActiveContextTimeToLive) String() string

String returns the string representation

func (*ActiveContextTimeToLive) Validate added in v1.35.32 

func (s *ActiveContextTimeToLive) Validate() error

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

type BadGatewayException added in v1.28.0 

type BadGatewayException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda) failed with an internal service error.

func (*BadGatewayException) Code added in v1.28.0 

func (s *BadGatewayException) Code() string

Code returns the exception type name.

func (*BadGatewayException) Error added in v1.28.0 

func (s *BadGatewayException) Error() string

func (BadGatewayException) GoString added in v1.28.0 

func (s BadGatewayException) GoString() string

GoString returns the string representation

func (*BadGatewayException) Message added in v1.28.0 

func (s *BadGatewayException) Message() string

Message returns the exception's message.

func (*BadGatewayException) OrigErr added in v1.28.0 

func (s *BadGatewayException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadGatewayException) RequestID added in v1.28.0 

func (s *BadGatewayException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadGatewayException) StatusCode added in v1.28.0 

func (s *BadGatewayException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadGatewayException) String added in v1.28.0 

func (s BadGatewayException) String() string

String returns the string representation

type BadRequestException added in v1.28.0 

type BadRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

func (*BadRequestException) Code added in v1.28.0 

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error added in v1.28.0 

func (s *BadRequestException) Error() string

func (BadRequestException) GoString added in v1.28.0 

func (s BadRequestException) GoString() string

GoString returns the string representation

func (*BadRequestException) Message added in v1.28.0 

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr added in v1.28.0 

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID added in v1.28.0 

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode added in v1.28.0 

func (s *BadRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadRequestException) String added in v1.28.0 

func (s BadRequestException) String() string

String returns the string representation

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

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 ConflictException added in v1.28.0 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ConflictException) Code added in v1.28.0 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.28.0 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.28.0 

func (s ConflictException) GoString() string

GoString returns the string representation

func (*ConflictException) Message added in v1.28.0 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.28.0 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.28.0 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.28.0 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.28.0 

func (s ConflictException) String() string

String returns the string representation

type DeleteSessionInput added in v1.22.3 

type DeleteSessionInput struct {

	// The alias in use for the bot that contains the session data.
	//
	// BotAlias is a required field
	BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"`

	// The name of the bot that contains the session data.
	//
	// BotName is a required field
	BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"`

	// The identifier of the user associated with the session data.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSessionInput) GoString added in v1.22.3 

func (s DeleteSessionInput) GoString() string

GoString returns the string representation

func (*DeleteSessionInput) SetBotAlias added in v1.22.3 

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

SetBotAlias sets the BotAlias field's value.

func (*DeleteSessionInput) SetBotName added in v1.22.3 

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

SetBotName sets the BotName field's value.

func (*DeleteSessionInput) SetUserId added in v1.22.3 

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

SetUserId sets the UserId field's value.

func (DeleteSessionInput) String added in v1.22.3 

func (s DeleteSessionInput) String() string

String returns the string representation

func (*DeleteSessionInput) Validate added in v1.22.3 

func (s *DeleteSessionInput) Validate() error

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

type DeleteSessionOutput added in v1.22.3 

type DeleteSessionOutput struct {

	// The alias in use for the bot associated with the session data.
	BotAlias *string `locationName:"botAlias" type:"string"`

	// The name of the bot associated with the session data.
	BotName *string `locationName:"botName" type:"string"`

	// The unique identifier for the session.
	SessionId *string `locationName:"sessionId" type:"string"`

	// The ID of the client application user.
	UserId *string `locationName:"userId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteSessionOutput) GoString added in v1.22.3 

func (s DeleteSessionOutput) GoString() string

GoString returns the string representation

func (*DeleteSessionOutput) SetBotAlias added in v1.22.3 

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

SetBotAlias sets the BotAlias field's value.

func (*DeleteSessionOutput) SetBotName added in v1.22.3 

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

SetBotName sets the BotName field's value.

func (*DeleteSessionOutput) SetSessionId added in v1.22.3 

func (s *DeleteSessionOutput) SetSessionId(v string) *DeleteSessionOutput

SetSessionId sets the SessionId field's value.

func (*DeleteSessionOutput) SetUserId added in v1.22.3 

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

SetUserId sets the UserId field's value.

func (DeleteSessionOutput) String added in v1.22.3 

func (s DeleteSessionOutput) String() string

String returns the string representation

type DependencyFailedException added in v1.28.0 

type DependencyFailedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

One of the 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.

  • If a Lambda function takes longer than 30 seconds to execute.

  • If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.

func (*DependencyFailedException) Code added in v1.28.0 

func (s *DependencyFailedException) Code() string

Code returns the exception type name.

func (*DependencyFailedException) Error added in v1.28.0 

func (s *DependencyFailedException) Error() string

func (DependencyFailedException) GoString added in v1.28.0 

func (s DependencyFailedException) GoString() string

GoString returns the string representation

func (*DependencyFailedException) Message added in v1.28.0 

func (s *DependencyFailedException) Message() string

Message returns the exception's message.

func (*DependencyFailedException) OrigErr added in v1.28.0 

func (s *DependencyFailedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DependencyFailedException) RequestID added in v1.28.0 

func (s *DependencyFailedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DependencyFailedException) StatusCode added in v1.28.0 

func (s *DependencyFailedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DependencyFailedException) String added in v1.28.0 

func (s DependencyFailedException) String() string

String returns the string representation

type DialogAction added in v1.22.3 

type DialogAction struct {

	// The fulfillment state of the intent. The possible values are:
	//
	//    * Failed - The Lambda function associated with the intent failed to fulfill
	//    the intent.
	//
	//    * Fulfilled - The intent has fulfilled by the Lambda function associated
	//    with the intent.
	//
	//    * ReadyForFulfillment - All of the information necessary for the intent
	//    is present and the intent ready to be fulfilled by the client application.
	FulfillmentState *string `locationName:"fulfillmentState" type:"string" enum:"FulfillmentState"`

	// The name of the intent.
	IntentName *string `locationName:"intentName" type:"string"`

	// The message that should be shown to the user. If you don't specify a message,
	// Amazon Lex will use the message configured for the intent.
	Message *string `locationName:"message" min:"1" type:"string" sensitive:"true"`

	//    * PlainText - The message contains plain UTF-8 text.
	//
	//    * CustomPayload - The message is a custom format for the client.
	//
	//    * SSML - The message contains text formatted for voice output.
	//
	//    * Composite - The message contains an escaped JSON object containing one
	//    or more messages. For more information, see Message Groups (https://docs.aws.amazon.com/lex/latest/dg/howitworks-manage-prompts.html).
	MessageFormat *string `locationName:"messageFormat" type:"string" enum:"MessageFormatType"`

	// The name of the slot that should be elicited from the user.
	SlotToElicit *string `locationName:"slotToElicit" type:"string"`

	// Map of the slots that have been gathered and their values.
	Slots map[string]*string `locationName:"slots" type:"map" sensitive:"true"`

	// The next action that the bot should take in its interaction with the user.
	// The possible values are:
	//
	//    * ConfirmIntent - The next action is asking the user if the intent is
	//    complete and ready to be fulfilled. This is a yes/no question such as
	//    "Place the order?"
	//
	//    * Close - Indicates that the there will not be a response from the user.
	//    For example, the statement "Your order has been placed" does not require
	//    a response.
	//
	//    * Delegate - The next action is determined by Amazon Lex.
	//
	//    * ElicitIntent - The next action is to determine the intent that the user
	//    wants to fulfill.
	//
	//    * ElicitSlot - The next action is to elicit a slot value from the user.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"DialogActionType"`
	// contains filtered or unexported fields
}

Describes the next action that the bot should take in its interaction with the user and provides information about the context in which the action takes place. Use the DialogAction data type to set the interaction to a specific state, or to return the interaction to a previous state.

func (DialogAction) GoString added in v1.22.3 

func (s DialogAction) GoString() string

GoString returns the string representation

func (*DialogAction) SetFulfillmentState added in v1.22.3 

func (s *DialogAction) SetFulfillmentState(v string) *DialogAction

SetFulfillmentState sets the FulfillmentState field's value.

func (*DialogAction) SetIntentName added in v1.22.3 

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

SetIntentName sets the IntentName field's value.

func (*DialogAction) SetMessage added in v1.22.3 

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

SetMessage sets the Message field's value.

func (*DialogAction) SetMessageFormat added in v1.22.3 

func (s *DialogAction) SetMessageFormat(v string) *DialogAction

SetMessageFormat sets the MessageFormat field's value.

func (*DialogAction) SetSlotToElicit added in v1.22.3 

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

SetSlotToElicit sets the SlotToElicit field's value.

func (*DialogAction) SetSlots added in v1.22.3 

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

SetSlots sets the Slots field's value.

func (*DialogAction) SetType added in v1.22.3 

func (s *DialogAction) SetType(v string) *DialogAction

SetType sets the Type field's value.

func (DialogAction) String added in v1.22.3 

func (s DialogAction) String() string

String returns the string representation

func (*DialogAction) Validate added in v1.22.3 

func (s *DialogAction) Validate() error

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

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.

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 GetSessionInput added in v1.22.3 

type GetSessionInput struct {

	// The alias in use for the bot that contains the session data.
	//
	// BotAlias is a required field
	BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"`

	// The name of the bot that contains the session data.
	//
	// BotName is a required field
	BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"`

	// A string used to filter the intents returned in the recentIntentSummaryView
	// structure.
	//
	// When you specify a filter, only intents with their checkpointLabel field
	// set to that string are returned.
	CheckpointLabelFilter *string `location:"querystring" locationName:"checkpointLabelFilter" min:"1" type:"string"`

	// The ID of the client application user. Amazon Lex uses this to identify a
	// user's conversation with your bot.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSessionInput) GoString added in v1.22.3 

func (s GetSessionInput) GoString() string

GoString returns the string representation

func (*GetSessionInput) SetBotAlias added in v1.22.3 

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

SetBotAlias sets the BotAlias field's value.

func (*GetSessionInput) SetBotName added in v1.22.3 

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

SetBotName sets the BotName field's value.

func (*GetSessionInput) SetCheckpointLabelFilter added in v1.25.10 

func (s *GetSessionInput) SetCheckpointLabelFilter(v string) *GetSessionInput

SetCheckpointLabelFilter sets the CheckpointLabelFilter field's value.

func (*GetSessionInput) SetUserId added in v1.22.3 

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

SetUserId sets the UserId field's value.

func (GetSessionInput) String added in v1.22.3 

func (s GetSessionInput) String() string

String returns the string representation

func (*GetSessionInput) Validate added in v1.22.3 

func (s *GetSessionInput) Validate() error

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

type GetSessionOutput added in v1.22.3 

type GetSessionOutput struct {

	// A list of active contexts for the session. A context can be set when an intent
	// is fulfilled or by calling the PostContent, PostText, or PutSession operation.
	//
	// You can use a context to control the intents that can follow up an intent,
	// or to modify the operation of your application.
	ActiveContexts []*ActiveContext `locationName:"activeContexts" type:"list" sensitive:"true"`

	// Describes the current state of the bot.
	DialogAction *DialogAction `locationName:"dialogAction" type:"structure"`

	// An array of information about the intents used in the session. The array
	// can contain a maximum of three summaries. If more than three intents are
	// used in the session, the recentIntentSummaryView operation contains information
	// about the last three intents used.
	//
	// If you set the checkpointLabelFilter parameter in the request, the array
	// contains only the intents with the specified label.
	RecentIntentSummaryView []*IntentSummary `locationName:"recentIntentSummaryView" type:"list"`

	// Map of key/value pairs representing the session-specific context information.
	// It contains application information passed between Amazon Lex and a client
	// application.
	SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map" sensitive:"true"`

	// A unique identifier for the session.
	SessionId *string `locationName:"sessionId" type:"string"`
	// contains filtered or unexported fields
}

func (GetSessionOutput) GoString added in v1.22.3 

func (s GetSessionOutput) GoString() string

GoString returns the string representation

func (*GetSessionOutput) SetActiveContexts added in v1.35.32 

func (s *GetSessionOutput) SetActiveContexts(v []*ActiveContext) *GetSessionOutput

SetActiveContexts sets the ActiveContexts field's value.

func (*GetSessionOutput) SetDialogAction added in v1.22.3 

func (s *GetSessionOutput) SetDialogAction(v *DialogAction) *GetSessionOutput

SetDialogAction sets the DialogAction field's value.

func (*GetSessionOutput) SetRecentIntentSummaryView added in v1.22.3 

func (s *GetSessionOutput) SetRecentIntentSummaryView(v []*IntentSummary) *GetSessionOutput

SetRecentIntentSummaryView sets the RecentIntentSummaryView field's value.

func (*GetSessionOutput) SetSessionAttributes added in v1.22.3 

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

SetSessionAttributes sets the SessionAttributes field's value.

func (*GetSessionOutput) SetSessionId added in v1.22.3 

func (s *GetSessionOutput) SetSessionId(v string) *GetSessionOutput

SetSessionId sets the SessionId field's value.

func (GetSessionOutput) String added in v1.22.3 

func (s GetSessionOutput) String() string

String returns the string representation

type IntentConfidence added in v1.33.21 

type IntentConfidence struct {

	// A score that indicates how confident Amazon Lex is that an intent satisfies
	// the user's intent. Ranges between 0.00 and 1.00. Higher scores indicate higher
	// confidence.
	Score *float64 `locationName:"score" type:"double"`
	// contains filtered or unexported fields
}

Provides a score that indicates the confidence that Amazon Lex has that an intent is the one that satisfies the user's intent.

func (IntentConfidence) GoString added in v1.33.21 

func (s IntentConfidence) GoString() string

GoString returns the string representation

func (*IntentConfidence) SetScore added in v1.33.21 

func (s *IntentConfidence) SetScore(v float64) *IntentConfidence

SetScore sets the Score field's value.

func (IntentConfidence) String added in v1.33.21 

func (s IntentConfidence) String() string

String returns the string representation

type IntentSummary added in v1.22.3 

type IntentSummary struct {

	// A user-defined label that identifies a particular intent. You can use this
	// label to return to a previous intent.
	//
	// Use the checkpointLabelFilter parameter of the GetSessionRequest operation
	// to filter the intents returned by the operation to those with only the specified
	// label.
	CheckpointLabel *string `locationName:"checkpointLabel" min:"1" type:"string"`

	// The status of the intent after the user responds to the confirmation prompt.
	// If the user confirms the intent, Amazon Lex sets this field to Confirmed.
	// If the user denies the intent, Amazon Lex sets this value to Denied. The
	// possible values are:
	//
	//    * Confirmed - The user has responded "Yes" to the confirmation prompt,
	//    confirming that the intent is complete and that it is ready to be fulfilled.
	//
	//    * Denied - The user has responded "No" to the confirmation prompt.
	//
	//    * None - The user has never been prompted for confirmation; or, the user
	//    was prompted but did not confirm or deny the prompt.
	ConfirmationStatus *string `locationName:"confirmationStatus" type:"string" enum:"ConfirmationStatus"`

	// The next action that the bot should take in its interaction with the user.
	// The possible values are:
	//
	//    * ConfirmIntent - The next action is asking the user if the intent is
	//    complete and ready to be fulfilled. This is a yes/no question such as
	//    "Place the order?"
	//
	//    * Close - Indicates that the there will not be a response from the user.
	//    For example, the statement "Your order has been placed" does not require
	//    a response.
	//
	//    * ElicitIntent - The next action is to determine the intent that the user
	//    wants to fulfill.
	//
	//    * ElicitSlot - The next action is to elicit a slot value from the user.
	//
	// DialogActionType is a required field
	DialogActionType *string `locationName:"dialogActionType" type:"string" required:"true" enum:"DialogActionType"`

	// The fulfillment state of the intent. The possible values are:
	//
	//    * Failed - The Lambda function associated with the intent failed to fulfill
	//    the intent.
	//
	//    * Fulfilled - The intent has fulfilled by the Lambda function associated
	//    with the intent.
	//
	//    * ReadyForFulfillment - All of the information necessary for the intent
	//    is present and the intent ready to be fulfilled by the client application.
	FulfillmentState *string `locationName:"fulfillmentState" type:"string" enum:"FulfillmentState"`

	// The name of the intent.
	IntentName *string `locationName:"intentName" type:"string"`

	// The next slot to elicit from the user. If there is not slot to elicit, the
	// field is blank.
	SlotToElicit *string `locationName:"slotToElicit" type:"string"`

	// Map of the slots that have been gathered and their values.
	Slots map[string]*string `locationName:"slots" type:"map" sensitive:"true"`
	// contains filtered or unexported fields
}

Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its previous state.

func (IntentSummary) GoString added in v1.22.3 

func (s IntentSummary) GoString() string

GoString returns the string representation

func (*IntentSummary) SetCheckpointLabel added in v1.25.10 

func (s *IntentSummary) SetCheckpointLabel(v string) *IntentSummary

SetCheckpointLabel sets the CheckpointLabel field's value.

func (*IntentSummary) SetConfirmationStatus added in v1.22.3 

func (s *IntentSummary) SetConfirmationStatus(v string) *IntentSummary

SetConfirmationStatus sets the ConfirmationStatus field's value.

func (*IntentSummary) SetDialogActionType added in v1.22.3 

func (s *IntentSummary) SetDialogActionType(v string) *IntentSummary

SetDialogActionType sets the DialogActionType field's value.

func (*IntentSummary) SetFulfillmentState added in v1.22.3 

func (s *IntentSummary) SetFulfillmentState(v string) *IntentSummary

SetFulfillmentState sets the FulfillmentState field's value.

func (*IntentSummary) SetIntentName added in v1.22.3 

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

SetIntentName sets the IntentName field's value.

func (*IntentSummary) SetSlotToElicit added in v1.22.3 

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

SetSlotToElicit sets the SlotToElicit field's value.

func (*IntentSummary) SetSlots added in v1.22.3 

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

SetSlots sets the Slots field's value.

func (IntentSummary) String added in v1.22.3 

func (s IntentSummary) String() string

String returns the string representation

func (*IntentSummary) Validate added in v1.25.10 

func (s *IntentSummary) Validate() error

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

type InternalFailureException added in v1.28.0 

type InternalFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Internal service error. Retry the call.

func (*InternalFailureException) Code added in v1.28.0 

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error added in v1.28.0 

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString added in v1.28.0 

func (s InternalFailureException) GoString() string

GoString returns the string representation

func (*InternalFailureException) Message added in v1.28.0 

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr added in v1.28.0 

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID added in v1.28.0 

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode added in v1.28.0 

func (s *InternalFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalFailureException) String added in v1.28.0 

func (s InternalFailureException) 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: 

mySession := session.Must(session.NewSession())

// 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) DeleteSession added in v1.22.3 

func (c *LexRuntimeService) DeleteSession(input *DeleteSessionInput) (*DeleteSessionOutput, error)

DeleteSession API operation for Amazon Lex Runtime Service.

Removes session information for a specified bot, alias, and user ID.

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 DeleteSession for usage and error information.

Returned Error Types:

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

  • BadRequestException Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

  • LimitExceededException Exceeded a limit.

  • InternalFailureException Internal service error. Retry the call.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/DeleteSession

func (*LexRuntimeService) DeleteSessionRequest added in v1.22.3 

func (c *LexRuntimeService) DeleteSessionRequest(input *DeleteSessionInput) (req *request.Request, output *DeleteSessionOutput)

DeleteSessionRequest generates a "aws/request.Request" representing the client's request for the DeleteSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSession for more information on using the DeleteSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/DeleteSession

func (*LexRuntimeService) DeleteSessionWithContext added in v1.22.3 

func (c *LexRuntimeService) DeleteSessionWithContext(ctx aws.Context, input *DeleteSessionInput, opts ...request.Option) (*DeleteSessionOutput, error)

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

See DeleteSession 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) GetSession added in v1.22.3 

func (c *LexRuntimeService) GetSession(input *GetSessionInput) (*GetSessionOutput, error)

GetSession API operation for Amazon Lex Runtime Service.

Returns session information for a specified bot, alias, and user ID.

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 GetSession for usage and error information.

Returned Error Types:

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

  • BadRequestException Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

  • LimitExceededException Exceeded a limit.

  • InternalFailureException Internal service error. Retry the call.

See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/GetSession

func (*LexRuntimeService) GetSessionRequest added in v1.22.3 

func (c *LexRuntimeService) GetSessionRequest(input *GetSessionInput) (req *request.Request, output *GetSessionOutput)

GetSessionRequest generates a "aws/request.Request" representing the client's request for the GetSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSession for more information on using the GetSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/GetSession

func (*LexRuntimeService) GetSessionWithContext added in v1.22.3 

func (c *LexRuntimeService) GetSessionWithContext(ctx aws.Context, input *GetSessionInput, opts ...request.Option) (*GetSessionOutput, error)

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

See GetSession 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) 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 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 (https://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 Types:

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

  • BadRequestException Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

  • LimitExceededException Exceeded a limit.

  • InternalFailureException Internal service error. Retry the call.

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

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

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

  • RequestTimeoutException The input speech is too long.

  • DependencyFailedException One of the 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.

  • If a Lambda function takes longer than 30 seconds to execute.

  • If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.

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

  • LoopDetectedException This exception is not used.

See also, 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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PostContent for more information on using the PostContent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, 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 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 (https://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 Types:

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

  • BadRequestException Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

  • LimitExceededException Exceeded a limit.

  • InternalFailureException Internal service error. Retry the call.

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

  • DependencyFailedException One of the 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.

  • If a Lambda function takes longer than 30 seconds to execute.

  • If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.

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

  • LoopDetectedException This exception is not used.

See also, 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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PostText for more information on using the PostText API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// 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)
}

See also, 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.

func (*LexRuntimeService) PutSession added in v1.22.3 

func (c *LexRuntimeService) PutSession(input *PutSessionInput) (*PutSessionOutput, error)

PutSession API operation for Amazon Lex Runtime Service.

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 (https://docs.aws.amazon.com/lex/latest/dg/how-session-api.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 PutSession for usage and error information.

Returned Error Types:

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

  • BadRequestException Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

  • LimitExceededException Exceeded a limit.

  • InternalFailureException Internal service error. Retry the call.

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

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

  • DependencyFailedException One of the 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.

  • If a Lambda function takes longer than 30 seconds to execute.

  • If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PutSession

func (*LexRuntimeService) PutSessionRequest added in v1.22.3 

func (c *LexRuntimeService) PutSessionRequest(input *PutSessionInput) (req *request.Request, output *PutSessionOutput)

PutSessionRequest generates a "aws/request.Request" representing the client's request for the PutSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutSession for more information on using the PutSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PutSession

func (*LexRuntimeService) PutSessionWithContext added in v1.22.3 

func (c *LexRuntimeService) PutSessionWithContext(ctx aws.Context, input *PutSessionInput, opts ...request.Option) (*PutSessionOutput, error)

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

See PutSession 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 LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	RetryAfterSeconds *string `location:"header" locationName:"Retry-After" type:"string"`
	// contains filtered or unexported fields
}

Exceeded a limit.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation

type LoopDetectedException added in v1.28.0 

type LoopDetectedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

This exception is not used.

func (*LoopDetectedException) Code added in v1.28.0 

func (s *LoopDetectedException) Code() string

Code returns the exception type name.

func (*LoopDetectedException) Error added in v1.28.0 

func (s *LoopDetectedException) Error() string

func (LoopDetectedException) GoString added in v1.28.0 

func (s LoopDetectedException) GoString() string

GoString returns the string representation

func (*LoopDetectedException) Message added in v1.28.0 

func (s *LoopDetectedException) Message() string

Message returns the exception's message.

func (*LoopDetectedException) OrigErr added in v1.28.0 

func (s *LoopDetectedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LoopDetectedException) RequestID added in v1.28.0 

func (s *LoopDetectedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LoopDetectedException) StatusCode added in v1.28.0 

func (s *LoopDetectedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LoopDetectedException) String added in v1.28.0 

func (s LoopDetectedException) String() string

String returns the string representation

type NotAcceptableException added in v1.28.0 

type NotAcceptableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The accept header in the request does not have a valid value.

func (*NotAcceptableException) Code added in v1.28.0 

func (s *NotAcceptableException) Code() string

Code returns the exception type name.

func (*NotAcceptableException) Error added in v1.28.0 

func (s *NotAcceptableException) Error() string

func (NotAcceptableException) GoString added in v1.28.0 

func (s NotAcceptableException) GoString() string

GoString returns the string representation

func (*NotAcceptableException) Message added in v1.28.0 

func (s *NotAcceptableException) Message() string

Message returns the exception's message.

func (*NotAcceptableException) OrigErr added in v1.28.0 

func (s *NotAcceptableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotAcceptableException) RequestID added in v1.28.0 

func (s *NotAcceptableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotAcceptableException) StatusCode added in v1.28.0 

func (s *NotAcceptableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotAcceptableException) String added in v1.28.0 

func (s NotAcceptableException) String() string

String returns the string representation

type NotFoundException added in v1.28.0 

type NotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*NotFoundException) Code added in v1.28.0 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0 

func (s NotFoundException) GoString() string

GoString returns the string representation

func (*NotFoundException) Message added in v1.28.0 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0 

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String added in v1.28.0 

func (s NotFoundException) String() string

String returns the string representation

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.
	//
	//    * 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)
	Accept *string `location:"header" locationName:"Accept" type:"string"`

	// 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.
	ActiveContexts aws.JSONValue `location:"header" locationName:"x-amz-lex-active-contexts" type:"jsonvalue"`

	// 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 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
	//
	// 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.
	//
	// 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.
	//
	// To use an non-seekable io.Reader for this request wrap the io.Reader with
	// "aws.ReadSeekCloser". The SDK will not retry request errors for non-seekable
	// readers. This will allow the SDK to send the reader's payload as chunked
	// transfer encoding.
	//
	// InputStream is a required field
	InputStream io.ReadSeeker `locationName:"inputStream" type:"blob" required:"true"`

	// 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 (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs).
	RequestAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-request-attributes" type:"jsonvalue"`

	// 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 (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs).
	SessionAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-session-attributes" type:"jsonvalue"`

	// 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.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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) SetActiveContexts added in v1.35.32 

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

SetActiveContexts sets the ActiveContexts 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) SetRequestAttributes added in v1.10.50 

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

SetRequestAttributes sets the RequestAttributes 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 {

	// A list of active contexts for the session. A context can be set when an intent
	// is fulfilled or by calling the PostContent, PostText, or PutSession operation.
	//
	// You can use a context to control the intents that can follow up an intent,
	// or to modify the operation of your application.
	ActiveContexts aws.JSONValue `location:"header" locationName:"x-amz-lex-active-contexts" type:"jsonvalue"`

	// One to four alternative intents that may be applicable to the user's intent.
	//
	// Each alternative includes a score that indicates how confident Amazon Lex
	// is that the intent matches the user's intent. The intents are sorted by the
	// confidence score.
	AlternativeIntents aws.JSONValue `location:"header" locationName:"x-amz-lex-alternative-intents" type:"jsonvalue"`

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

	// The version of the bot that responded to the conversation. You can use this
	// information to help determine if one version of a bot is performing better
	// than another version.
	BotVersion *string `location:"header" locationName:"x-amz-lex-bot-version" min:"1" type:"string"`

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

	// The text used to process the request.
	//
	// If the input was an audio stream, the encodedInputTranscript field contains
	// the text extracted from the audio stream. This is the text that is actually
	// processed to recognize intents and slot values. You can use this information
	// to determine if Amazon Lex is correctly processing the audio that you send.
	//
	// The encodedInputTranscript field is base-64 encoded. You must decode the
	// field before you can use the value.
	EncodedInputTranscript *string `location:"header" locationName:"x-amz-lex-encoded-input-transcript" type:"string" sensitive:"true"`

	// The message to convey to the user. The message can come from the bot's configuration
	// or from a Lambda function.
	//
	// If the intent is not configured with a Lambda function, or if the Lambda
	// function returned Delegate as the dialogAction.type in its response, Amazon
	// Lex decides on the next course of action and selects an appropriate message
	// from the bot's configuration based on the current interaction context. For
	// example, if Amazon Lex isn't able to understand user input, it uses a clarification
	// prompt message.
	//
	// When you create an intent you can assign messages to groups. When messages
	// are assigned to groups Amazon Lex returns one message from each group in
	// the response. The message field is an escaped JSON string containing the
	// messages. For more information about the structure of the JSON string returned,
	// see msg-prompts-formats.
	//
	// If the Lambda function returns a message, Amazon Lex passes it to the client
	// in its response.
	//
	// The encodedMessage field is base-64 encoded. You must decode the field before
	// you can use the value.
	EncodedMessage *string `location:"header" locationName:"x-amz-lex-encoded-message" min:"1" type:"string" sensitive:"true"`

	// The text used to process the request.
	//
	// You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES,
	// es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the inputTranscript
	// field is null. You should use the encodedInputTranscript field instead.
	//
	// If the input was an audio stream, the inputTranscript field contains the
	// text extracted from the audio stream. This is the text that is actually processed
	// to recognize intents and slot values. You can use this information to determine
	// if Amazon Lex is correctly processing the audio that you send.
	//
	// Deprecated: The inputTranscript field is deprecated, use the encodedInputTranscript field instead. The inputTranscript field is available only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR and it-IT locales.
	InputTranscript *string `location:"header" locationName:"x-amz-lex-input-transcript" deprecated:"true" type:"string"`

	// Current user intent that Amazon Lex is aware of.
	IntentName *string `location:"header" locationName:"x-amz-lex-intent-name" type:"string"`

	// You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES,
	// es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message
	// field is null. You should use the encodedMessage field instead.
	//
	// The message to convey to the user. The message can come from the bot's configuration
	// or from a Lambda function.
	//
	// If the intent is not configured with a Lambda function, or if the Lambda
	// function returned Delegate as the dialogAction.type in its response, Amazon
	// Lex decides on the next course of action and selects an appropriate message
	// from the bot's configuration based on the current interaction context. For
	// example, if Amazon Lex isn't able to understand user input, it uses a clarification
	// prompt message.
	//
	// When you create an intent you can assign messages to groups. When messages
	// are assigned to groups Amazon Lex returns one message from each group in
	// the response. The message field is an escaped JSON string containing the
	// messages. For more information about the structure of the JSON string returned,
	// see msg-prompts-formats.
	//
	// If the Lambda function returns a message, Amazon Lex passes it to the client
	// in its response.
	//
	// Deprecated: The message field is deprecated, use the encodedMessage field instead. The message field is available only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR and it-IT locales.
	Message *string `location:"header" locationName:"x-amz-lex-message" min:"1" deprecated:"true" type:"string" sensitive:"true"`

	// The format of the response message. One of the following values:
	//
	//    * PlainText - The message contains plain UTF-8 text.
	//
	//    * CustomPayload - The message is a custom format for the client.
	//
	//    * SSML - The message contains text formatted for voice output.
	//
	//    * Composite - The message contains an escaped JSON object containing one
	//    or more messages from the groups that messages were assigned to when the
	//    intent was created.
	MessageFormat *string `location:"header" locationName:"x-amz-lex-message-format" type:"string" enum:"MessageFormatType"`

	// Provides a score that indicates how confident Amazon Lex is that the returned
	// intent is the one that matches the user's intent. The score is between 0.0
	// and 1.0.
	//
	// The score is a relative score, not an absolute score. The score may change
	// based on improvements to Amazon Lex.
	NluIntentConfidence aws.JSONValue `location:"header" locationName:"x-amz-lex-nlu-intent-confidence" type:"jsonvalue"`

	// The sentiment expressed in an utterance.
	//
	// When the bot is configured to send utterances to Amazon Comprehend for sentiment
	// analysis, this field contains the result of the analysis.
	SentimentResponse *string `location:"header" locationName:"x-amz-lex-sentiment" 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"`

	// The unique identifier for the session.
	SessionId *string `location:"header" locationName:"x-amz-lex-session-id" type:"string"`

	// 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. The field is base-64 encoded.
	//
	// Amazon Lex creates a resolution list containing likely values for a slot.
	// The value that it returns is determined by the valueSelectionStrategy selected
	// when the slot type was created or updated. If valueSelectionStrategy is set
	// to ORIGINAL_VALUE, the value provided by the user is returned, if the user
	// value is similar to the slot values. If valueSelectionStrategy is set to
	// TOP_RESOLUTION Amazon Lex returns the first value in the resolution list
	// or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy,
	// the default is ORIGINAL_VALUE.
	Slots aws.JSONValue `location:"header" locationName:"x-amz-lex-slots" type:"jsonvalue"`
	// contains filtered or unexported fields
}

func (PostContentOutput) GoString added in v1.8.7 

func (s PostContentOutput) GoString() string

GoString returns the string representation

func (*PostContentOutput) SetActiveContexts added in v1.35.32 

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

SetActiveContexts sets the ActiveContexts field's value.

func (*PostContentOutput) SetAlternativeIntents added in v1.33.21 

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

SetAlternativeIntents sets the AlternativeIntents field's value.

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) SetBotVersion added in v1.33.21 

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

SetBotVersion sets the BotVersion 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) SetEncodedInputTranscript added in v1.38.11 

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

SetEncodedInputTranscript sets the EncodedInputTranscript field's value.

func (*PostContentOutput) SetEncodedMessage added in v1.38.11 

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

SetEncodedMessage sets the EncodedMessage 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) SetMessageFormat added in v1.12.74 

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

SetMessageFormat sets the MessageFormat field's value.

func (*PostContentOutput) SetNluIntentConfidence added in v1.33.21 

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

SetNluIntentConfidence sets the NluIntentConfidence field's value.

func (*PostContentOutput) SetSentimentResponse added in v1.25.40 

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

SetSentimentResponse sets the SentimentResponse 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) SetSessionId added in v1.25.42 

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

SetSessionId sets the SessionId 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 {

	// 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.
	ActiveContexts []*ActiveContext `locationName:"activeContexts" type:"list" sensitive:"true"`

	// 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" sensitive:"true"`

	// Request-specific information passed between Amazon Lex and a client application.
	//
	// 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 (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs).
	RequestAttributes map[string]*string `locationName:"requestAttributes" type:"map" sensitive:"true"`

	// Application-specific information passed between Amazon Lex and a client application.
	//
	// For more information, see Setting Session Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs).
	SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map" sensitive:"true"`

	// 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.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PostTextInput) GoString 

func (s PostTextInput) GoString() string

GoString returns the string representation

func (*PostTextInput) SetActiveContexts added in v1.35.32 

func (s *PostTextInput) SetActiveContexts(v []*ActiveContext) *PostTextInput

SetActiveContexts sets the ActiveContexts field's value.

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) SetRequestAttributes added in v1.10.50 

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

SetRequestAttributes sets the RequestAttributes 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 {

	// A list of active contexts for the session. A context can be set when an intent
	// is fulfilled or by calling the PostContent, PostText, or PutSession operation.
	//
	// You can use a context to control the intents that can follow up an intent,
	// or to modify the operation of your application.
	ActiveContexts []*ActiveContext `locationName:"activeContexts" type:"list" sensitive:"true"`

	// One to four alternative intents that may be applicable to the user's intent.
	//
	// Each alternative includes a score that indicates how confident Amazon Lex
	// is that the intent matches the user's intent. The intents are sorted by the
	// confidence score.
	AlternativeIntents []*PredictedIntent `locationName:"alternativeIntents" type:"list"`

	// The version of the bot that responded to the conversation. You can use this
	// information to help determine if one version of a bot is performing better
	// than another version.
	BotVersion *string `locationName:"botVersion" min:"1" 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 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"`

	// The message to convey to the user. The message can come from the bot's configuration
	// or from a Lambda function.
	//
	// If the intent is not configured with a Lambda function, or if the Lambda
	// function returned Delegate as the dialogAction.type its response, Amazon
	// Lex decides on the next course of action and selects an appropriate message
	// from the bot's configuration based on the current interaction context. For
	// example, if Amazon Lex isn't able to understand user input, it uses a clarification
	// prompt message.
	//
	// When you create an intent you can assign messages to groups. When messages
	// are assigned to groups Amazon Lex returns one message from each group in
	// the response. The message field is an escaped JSON string containing the
	// messages. For more information about the structure of the JSON string returned,
	// see msg-prompts-formats.
	//
	// If the Lambda function returns a message, Amazon Lex passes it to the client
	// in its response.
	Message *string `locationName:"message" min:"1" type:"string" sensitive:"true"`

	// The format of the response message. One of the following values:
	//
	//    * PlainText - The message contains plain UTF-8 text.
	//
	//    * CustomPayload - The message is a custom format defined by the Lambda
	//    function.
	//
	//    * SSML - The message contains text formatted for voice output.
	//
	//    * Composite - The message contains an escaped JSON object containing one
	//    or more messages from the groups that messages were assigned to when the
	//    intent was created.
	MessageFormat *string `locationName:"messageFormat" type:"string" enum:"MessageFormatType"`

	// Provides a score that indicates how confident Amazon Lex is that the returned
	// intent is the one that matches the user's intent. The score is between 0.0
	// and 1.0. For more information, see Confidence Scores (https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html).
	//
	// The score is a relative score, not an absolute score. The score may change
	// based on improvements to Amazon Lex.
	NluIntentConfidence *IntentConfidence `locationName:"nluIntentConfidence" type:"structure"`

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

	// The sentiment expressed in and utterance.
	//
	// When the bot is configured to send utterances to Amazon Comprehend for sentiment
	// analysis, this field contains the result of the analysis.
	SentimentResponse *SentimentResponse `locationName:"sentimentResponse" type:"structure"`

	// A map of key-value pairs representing the session-specific context information.
	SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map" sensitive:"true"`

	// A unique identifier for the session.
	SessionId *string `locationName:"sessionId" type:"string"`

	// 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 that Amazon Lex detected from the user input in the conversation.
	//
	// Amazon Lex creates a resolution list containing likely values for a slot.
	// The value that it returns is determined by the valueSelectionStrategy selected
	// when the slot type was created or updated. If valueSelectionStrategy is set
	// to ORIGINAL_VALUE, the value provided by the user is returned, if the user
	// value is similar to the slot values. If valueSelectionStrategy is set to
	// TOP_RESOLUTION Amazon Lex returns the first value in the resolution list
	// or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy,
	// the default is ORIGINAL_VALUE.
	Slots map[string]*string `locationName:"slots" type:"map" sensitive:"true"`
	// contains filtered or unexported fields
}

func (PostTextOutput) GoString 

func (s PostTextOutput) GoString() string

GoString returns the string representation

func (*PostTextOutput) SetActiveContexts added in v1.35.32 

func (s *PostTextOutput) SetActiveContexts(v []*ActiveContext) *PostTextOutput

SetActiveContexts sets the ActiveContexts field's value.

func (*PostTextOutput) SetAlternativeIntents added in v1.33.21 

func (s *PostTextOutput) SetAlternativeIntents(v []*PredictedIntent) *PostTextOutput

SetAlternativeIntents sets the AlternativeIntents field's value.

func (*PostTextOutput) SetBotVersion added in v1.33.21 

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

SetBotVersion sets the BotVersion field's value.

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) SetMessageFormat added in v1.12.74 

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

SetMessageFormat sets the MessageFormat field's value.

func (*PostTextOutput) SetNluIntentConfidence added in v1.33.21 

func (s *PostTextOutput) SetNluIntentConfidence(v *IntentConfidence) *PostTextOutput

SetNluIntentConfidence sets the NluIntentConfidence field's value.

func (*PostTextOutput) SetResponseCard 

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

SetResponseCard sets the ResponseCard field's value.

func (*PostTextOutput) SetSentimentResponse added in v1.25.40 

func (s *PostTextOutput) SetSentimentResponse(v *SentimentResponse) *PostTextOutput

SetSentimentResponse sets the SentimentResponse field's value.

func (*PostTextOutput) SetSessionAttributes 

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

SetSessionAttributes sets the SessionAttributes field's value.

func (*PostTextOutput) SetSessionId added in v1.25.42 

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

SetSessionId sets the SessionId 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 PredictedIntent added in v1.33.21 

type PredictedIntent struct {

	// The name of the intent that Amazon Lex suggests satisfies the user's intent.
	IntentName *string `locationName:"intentName" type:"string"`

	// Indicates how confident Amazon Lex is that an intent satisfies the user's
	// intent.
	NluIntentConfidence *IntentConfidence `locationName:"nluIntentConfidence" type:"structure"`

	// The slot and slot values associated with the predicted intent.
	Slots map[string]*string `locationName:"slots" type:"map" sensitive:"true"`
	// contains filtered or unexported fields
}

An intent that Amazon Lex suggests satisfies the user's intent. Includes the name of the intent, the confidence that Amazon Lex has that the user's intent is satisfied, and the slots defined for the intent.

func (PredictedIntent) GoString added in v1.33.21 

func (s PredictedIntent) GoString() string

GoString returns the string representation

func (*PredictedIntent) SetIntentName added in v1.33.21 

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

SetIntentName sets the IntentName field's value.

func (*PredictedIntent) SetNluIntentConfidence added in v1.33.21 

func (s *PredictedIntent) SetNluIntentConfidence(v *IntentConfidence) *PredictedIntent

SetNluIntentConfidence sets the NluIntentConfidence field's value.

func (*PredictedIntent) SetSlots added in v1.33.21 

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

SetSlots sets the Slots field's value.

func (PredictedIntent) String added in v1.33.21 

func (s PredictedIntent) String() string

String returns the string representation

type PutSessionInput added in v1.22.3 

type PutSessionInput struct {

	// The message that Amazon Lex returns in the response can be either text or
	// speech based depending on the value of this field.
	//
	//    * 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 in the configuration
	//    that you specify. 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 is returned as audio/pcm in 16-bit,
	//    little endian format.
	//
	//    * The following are the accepted values: audio/mpeg audio/ogg audio/pcm
	//    audio/* (defaults to mpeg) text/plain; charset=utf-8
	Accept *string `location:"header" locationName:"Accept" type:"string"`

	// 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.
	ActiveContexts []*ActiveContext `locationName:"activeContexts" type:"list" sensitive:"true"`

	// The alias in use for the bot that contains the session data.
	//
	// BotAlias is a required field
	BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"`

	// The name of the bot that contains the session data.
	//
	// BotName is a required field
	BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"`

	// Sets the next action that the bot should take to fulfill the conversation.
	DialogAction *DialogAction `locationName:"dialogAction" type:"structure"`

	// A summary of the recent intents for the bot. You can use the intent summary
	// view to set a checkpoint label on an intent and modify attributes of intents.
	// You can also use it to remove or add intent summary objects to the list.
	//
	// An intent that you modify or add to the list must make sense for the bot.
	// For example, the intent name must be valid for the bot. You must provide
	// valid values for:
	//
	//    * intentName
	//
	//    * slot names
	//
	//    * slotToElict
	//
	// If you send the recentIntentSummaryView parameter in a PutSession request,
	// the contents of the new summary view replaces the old summary view. For example,
	// if a GetSession request returns three intents in the summary view and you
	// call PutSession with one intent in the summary view, the next call to GetSession
	// will only return one intent.
	RecentIntentSummaryView []*IntentSummary `locationName:"recentIntentSummaryView" type:"list"`

	// Map of key/value pairs representing the session-specific context information.
	// It contains application information passed between Amazon Lex and a client
	// application.
	SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map" sensitive:"true"`

	// The ID of the client application user. Amazon Lex uses this to identify a
	// user's conversation with your bot.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutSessionInput) GoString added in v1.22.3 

func (s PutSessionInput) GoString() string

GoString returns the string representation

func (*PutSessionInput) SetAccept added in v1.22.3 

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

SetAccept sets the Accept field's value.

func (*PutSessionInput) SetActiveContexts added in v1.35.32 

func (s *PutSessionInput) SetActiveContexts(v []*ActiveContext) *PutSessionInput

SetActiveContexts sets the ActiveContexts field's value.

func (*PutSessionInput) SetBotAlias added in v1.22.3 

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

SetBotAlias sets the BotAlias field's value.

func (*PutSessionInput) SetBotName added in v1.22.3 

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

SetBotName sets the BotName field's value.

func (*PutSessionInput) SetDialogAction added in v1.22.3 

func (s *PutSessionInput) SetDialogAction(v *DialogAction) *PutSessionInput

SetDialogAction sets the DialogAction field's value.

func (*PutSessionInput) SetRecentIntentSummaryView added in v1.25.10 

func (s *PutSessionInput) SetRecentIntentSummaryView(v []*IntentSummary) *PutSessionInput

SetRecentIntentSummaryView sets the RecentIntentSummaryView field's value.

func (*PutSessionInput) SetSessionAttributes added in v1.22.3 

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

SetSessionAttributes sets the SessionAttributes field's value.

func (*PutSessionInput) SetUserId added in v1.22.3 

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

SetUserId sets the UserId field's value.

func (PutSessionInput) String added in v1.22.3 

func (s PutSessionInput) String() string

String returns the string representation

func (*PutSessionInput) Validate added in v1.22.3 

func (s *PutSessionInput) Validate() error

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

type PutSessionOutput added in v1.22.3 

type PutSessionOutput struct {

	// A list of active contexts for the session.
	ActiveContexts aws.JSONValue `location:"header" locationName:"x-amz-lex-active-contexts" type:"jsonvalue"`

	// The audio version of the message to convey to the user.
	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"`

	//    * ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to
	//    confirm the intent before fulfilling an intent.
	//
	//    * ElicitIntent - Amazon Lex wants to elicit the user's intent.
	//
	//    * ElicitSlot - Amazon Lex is expecting the value of a slot for the current
	//    intent.
	//
	//    * Failed - Conveys that the conversation with the user has failed. This
	//    can happen for various reasons, including the user does not provide an
	//    appropriate response to prompts from the service, or if the Lambda function
	//    fails to fulfill the intent.
	//
	//    * Fulfilled - Conveys that the Lambda function has sucessfully fulfilled
	//    the intent.
	//
	//    * ReadyForFulfillment - Conveys that the client has to fulfill the intent.
	DialogState *string `location:"header" locationName:"x-amz-lex-dialog-state" type:"string" enum:"DialogState"`

	// The next message that should be presented to the user.
	//
	// The encodedMessage field is base-64 encoded. You must decode the field before
	// you can use the value.
	EncodedMessage *string `location:"header" locationName:"x-amz-lex-encoded-message" min:"1" type:"string" sensitive:"true"`

	// The name of the current intent.
	IntentName *string `location:"header" locationName:"x-amz-lex-intent-name" type:"string"`

	// The next message that should be presented to the user.
	//
	// You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES,
	// es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message
	// field is null. You should use the encodedMessage field instead.
	//
	// Deprecated: The message field is deprecated, use the encodedMessage field instead. The message field is available only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR and it-IT locales.
	Message *string `location:"header" locationName:"x-amz-lex-message" min:"1" deprecated:"true" type:"string" sensitive:"true"`

	// The format of the response message. One of the following values:
	//
	//    * PlainText - The message contains plain UTF-8 text.
	//
	//    * CustomPayload - The message is a custom format for the client.
	//
	//    * SSML - The message contains text formatted for voice output.
	//
	//    * Composite - The message contains an escaped JSON object containing one
	//    or more messages from the groups that messages were assigned to when the
	//    intent was created.
	MessageFormat *string `location:"header" locationName:"x-amz-lex-message-format" type:"string" enum:"MessageFormatType"`

	// Map of key/value pairs representing session-specific context information.
	SessionAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-session-attributes" type:"jsonvalue"`

	// A unique identifier for the session.
	SessionId *string `location:"header" locationName:"x-amz-lex-session-id" type:"string"`

	// If the dialogState 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 Amazon Lex detected from the user input
	// during the conversation.
	//
	// Amazon Lex creates a resolution list containing likely values for a slot.
	// The value that it returns is determined by the valueSelectionStrategy selected
	// when the slot type was created or updated. If valueSelectionStrategy is set
	// to ORIGINAL_VALUE, the value provided by the user is returned, if the user
	// value is similar to the slot values. If valueSelectionStrategy is set to
	// TOP_RESOLUTION Amazon Lex returns the first value in the resolution list
	// or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy
	// the default is ORIGINAL_VALUE.
	Slots aws.JSONValue `location:"header" locationName:"x-amz-lex-slots" type:"jsonvalue"`
	// contains filtered or unexported fields
}

func (PutSessionOutput) GoString added in v1.22.3 

func (s PutSessionOutput) GoString() string

GoString returns the string representation

func (*PutSessionOutput) SetActiveContexts added in v1.35.32 

func (s *PutSessionOutput) SetActiveContexts(v aws.JSONValue) *PutSessionOutput

SetActiveContexts sets the ActiveContexts field's value.

func (*PutSessionOutput) SetAudioStream added in v1.22.3 

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

SetAudioStream sets the AudioStream field's value.

func (*PutSessionOutput) SetContentType added in v1.22.3 

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

SetContentType sets the ContentType field's value.

func (*PutSessionOutput) SetDialogState added in v1.22.3 

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

SetDialogState sets the DialogState field's value.

func (*PutSessionOutput) SetEncodedMessage added in v1.38.11 

func (s *PutSessionOutput) SetEncodedMessage(v string) *PutSessionOutput

SetEncodedMessage sets the EncodedMessage field's value.

func (*PutSessionOutput) SetIntentName added in v1.22.3 

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

SetIntentName sets the IntentName field's value.

func (*PutSessionOutput) SetMessage added in v1.22.3 

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

SetMessage sets the Message field's value.

func (*PutSessionOutput) SetMessageFormat added in v1.22.3 

func (s *PutSessionOutput) SetMessageFormat(v string) *PutSessionOutput

SetMessageFormat sets the MessageFormat field's value.

func (*PutSessionOutput) SetSessionAttributes added in v1.22.3 

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

SetSessionAttributes sets the SessionAttributes field's value.

func (*PutSessionOutput) SetSessionId added in v1.22.3 

func (s *PutSessionOutput) SetSessionId(v string) *PutSessionOutput

SetSessionId sets the SessionId field's value.

func (*PutSessionOutput) SetSlotToElicit added in v1.22.3 

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

SetSlotToElicit sets the SlotToElicit field's value.

func (*PutSessionOutput) SetSlots added in v1.22.3 

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

SetSlots sets the Slots field's value.

func (PutSessionOutput) String added in v1.22.3 

func (s PutSessionOutput) String() string

String returns the string representation

type RequestTimeoutException added in v1.28.0 

type RequestTimeoutException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The input speech is too long.

func (*RequestTimeoutException) Code added in v1.28.0 

func (s *RequestTimeoutException) Code() string

Code returns the exception type name.

func (*RequestTimeoutException) Error added in v1.28.0 

func (s *RequestTimeoutException) Error() string

func (RequestTimeoutException) GoString added in v1.28.0 

func (s RequestTimeoutException) GoString() string

GoString returns the string representation

func (*RequestTimeoutException) Message added in v1.28.0 

func (s *RequestTimeoutException) Message() string

Message returns the exception's message.

func (*RequestTimeoutException) OrigErr added in v1.28.0 

func (s *RequestTimeoutException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RequestTimeoutException) RequestID added in v1.28.0 

func (s *RequestTimeoutException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RequestTimeoutException) StatusCode added in v1.28.0 

func (s *RequestTimeoutException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RequestTimeoutException) String added in v1.28.0 

func (s RequestTimeoutException) 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).

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

type SentimentResponse added in v1.25.40 

type SentimentResponse struct {

	// The inferred sentiment that Amazon Comprehend has the highest confidence
	// in.
	SentimentLabel *string `locationName:"sentimentLabel" type:"string"`

	// The likelihood that the sentiment was correctly inferred.
	SentimentScore *string `locationName:"sentimentScore" type:"string"`
	// contains filtered or unexported fields
}

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field structure contains the result of the analysis.

func (SentimentResponse) GoString added in v1.25.40 

func (s SentimentResponse) GoString() string

GoString returns the string representation

func (*SentimentResponse) SetSentimentLabel added in v1.25.40 

func (s *SentimentResponse) SetSentimentLabel(v string) *SentimentResponse

SetSentimentLabel sets the SentimentLabel field's value.

func (*SentimentResponse) SetSentimentScore added in v1.25.40 

func (s *SentimentResponse) SetSentimentScore(v string) *SentimentResponse

SetSentimentScore sets the SentimentScore field's value.

func (SentimentResponse) String added in v1.25.40 

func (s SentimentResponse) String() string

String returns the string representation

type UnsupportedMediaTypeException added in v1.28.0 

type UnsupportedMediaTypeException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The Content-Type header (PostContent API) has an invalid value.

func (*UnsupportedMediaTypeException) Code added in v1.28.0 

func (s *UnsupportedMediaTypeException) Code() string

Code returns the exception type name.

func (*UnsupportedMediaTypeException) Error added in v1.28.0 

func (s *UnsupportedMediaTypeException) Error() string

func (UnsupportedMediaTypeException) GoString added in v1.28.0 

func (s UnsupportedMediaTypeException) GoString() string

GoString returns the string representation

func (*UnsupportedMediaTypeException) Message added in v1.28.0 

func (s *UnsupportedMediaTypeException) Message() string

Message returns the exception's message.

func (*UnsupportedMediaTypeException) OrigErr added in v1.28.0 

func (s *UnsupportedMediaTypeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedMediaTypeException) RequestID added in v1.28.0 

func (s *UnsupportedMediaTypeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedMediaTypeException) StatusCode added in v1.28.0 

func (s *UnsupportedMediaTypeException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedMediaTypeException) String added in v1.28.0 

func (s UnsupportedMediaTypeException) 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.