lexruntimev2

package
v1.42.9 Latest Latest
Warning

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

 Go to latest Published: Aug 3, 2023 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

Package lexruntimev2 provides the client and types for making API requests to Amazon Lex Runtime V2.

This section contains documentation for the Amazon Lex V2 Runtime V2 API operations.

See https://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07 for more information on this service.

See lexruntimev2 package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/lexruntimev2/

Using the Client

To contact Amazon Lex Runtime V2 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 V2 client LexRuntimeV2 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/lexruntimev2/#New

Index

Constants

View Source 
const (
	// ConfirmationStateConfirmed is a ConfirmationState enum value
	ConfirmationStateConfirmed = "Confirmed"

	// ConfirmationStateDenied is a ConfirmationState enum value
	ConfirmationStateDenied = "Denied"

	// ConfirmationStateNone is a ConfirmationState enum value
	ConfirmationStateNone = "None"
)
View Source 
const (
	// ConversationModeAudio is a ConversationMode enum value
	ConversationModeAudio = "AUDIO"

	// ConversationModeText is a ConversationMode enum value
	ConversationModeText = "TEXT"
)
View Source 
const (
	// DialogActionTypeClose is a DialogActionType enum value
	DialogActionTypeClose = "Close"

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

	// DialogActionTypeDelegate is a DialogActionType enum value
	DialogActionTypeDelegate = "Delegate"

	// DialogActionTypeElicitIntent is a DialogActionType enum value
	DialogActionTypeElicitIntent = "ElicitIntent"

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

	// DialogActionTypeNone is a DialogActionType enum value
	DialogActionTypeNone = "None"
)
View Source 
const (
	// InputModeText is a InputMode enum value
	InputModeText = "Text"

	// InputModeSpeech is a InputMode enum value
	InputModeSpeech = "Speech"

	// InputModeDtmf is a InputMode enum value
	InputModeDtmf = "DTMF"
)
View Source 
const (
	// IntentStateFailed is a IntentState enum value
	IntentStateFailed = "Failed"

	// IntentStateFulfilled is a IntentState enum value
	IntentStateFulfilled = "Fulfilled"

	// IntentStateInProgress is a IntentState enum value
	IntentStateInProgress = "InProgress"

	// IntentStateReadyForFulfillment is a IntentState enum value
	IntentStateReadyForFulfillment = "ReadyForFulfillment"

	// IntentStateWaiting is a IntentState enum value
	IntentStateWaiting = "Waiting"

	// IntentStateFulfillmentInProgress is a IntentState enum value
	IntentStateFulfillmentInProgress = "FulfillmentInProgress"
)
View Source 
const (
	// MessageContentTypeCustomPayload is a MessageContentType enum value
	MessageContentTypeCustomPayload = "CustomPayload"

	// MessageContentTypeImageResponseCard is a MessageContentType enum value
	MessageContentTypeImageResponseCard = "ImageResponseCard"

	// MessageContentTypePlainText is a MessageContentType enum value
	MessageContentTypePlainText = "PlainText"

	// MessageContentTypeSsml is a MessageContentType enum value
	MessageContentTypeSsml = "SSML"
)
View Source 
const (
	// PlaybackInterruptionReasonDtmfStartDetected is a PlaybackInterruptionReason enum value
	PlaybackInterruptionReasonDtmfStartDetected = "DTMF_START_DETECTED"

	// PlaybackInterruptionReasonTextDetected is a PlaybackInterruptionReason enum value
	PlaybackInterruptionReasonTextDetected = "TEXT_DETECTED"

	// PlaybackInterruptionReasonVoiceStartDetected is a PlaybackInterruptionReason enum value
	PlaybackInterruptionReasonVoiceStartDetected = "VOICE_START_DETECTED"
)
View Source 
const (
	// SentimentTypeMixed is a SentimentType enum value
	SentimentTypeMixed = "MIXED"

	// SentimentTypeNegative is a SentimentType enum value
	SentimentTypeNegative = "NEGATIVE"

	// SentimentTypeNeutral is a SentimentType enum value
	SentimentTypeNeutral = "NEUTRAL"

	// SentimentTypePositive is a SentimentType enum value
	SentimentTypePositive = "POSITIVE"
)
View Source 
const (
	// ShapeScalar is a Shape enum value
	ShapeScalar = "Scalar"

	// ShapeList is a Shape enum value
	ShapeList = "List"

	// ShapeComposite is a Shape enum value
	ShapeComposite = "Composite"
)
View Source 
const (
	// StyleTypeDefault is a StyleType enum value
	StyleTypeDefault = "Default"

	// StyleTypeSpellByLetter is a StyleType enum value
	StyleTypeSpellByLetter = "SpellByLetter"

	// StyleTypeSpellByWord is a StyleType enum value
	StyleTypeSpellByWord = "SpellByWord"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeBadGatewayException for service response error code
	// "BadGatewayException".
	ErrCodeBadGatewayException = "BadGatewayException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	ErrCodeConflictException = "ConflictException"

	// ErrCodeDependencyFailedException for service response error code
	// "DependencyFailedException".
	ErrCodeDependencyFailedException = "DependencyFailedException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Lex Runtime V2" // Name of service.
	EndpointsID = "runtime-v2-lex" // ID to lookup a service endpoint with.
	ServiceID   = "Lex Runtime V2" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ConfirmationState_Values 

func ConfirmationState_Values() []string

ConfirmationState_Values returns all elements of the ConfirmationState enum

func ConversationMode_Values 

func ConversationMode_Values() []string

ConversationMode_Values returns all elements of the ConversationMode enum

func DialogActionType_Values 

func DialogActionType_Values() []string

DialogActionType_Values returns all elements of the DialogActionType enum

func InputMode_Values 

func InputMode_Values() []string

InputMode_Values returns all elements of the InputMode enum

func IntentState_Values 

func IntentState_Values() []string

IntentState_Values returns all elements of the IntentState enum

func MessageContentType_Values 

func MessageContentType_Values() []string

MessageContentType_Values returns all elements of the MessageContentType enum

func PlaybackInterruptionReason_Values 

func PlaybackInterruptionReason_Values() []string

PlaybackInterruptionReason_Values returns all elements of the PlaybackInterruptionReason enum

func SentimentType_Values 

func SentimentType_Values() []string

SentimentType_Values returns all elements of the SentimentType enum

func Shape_Values 

func Shape_Values() []string

Shape_Values returns all elements of the Shape enum

func StyleType_Values added in v1.42.9 

func StyleType_Values() []string

StyleType_Values returns all elements of the StyleType enum

Types

type AccessDeniedException 

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

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

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) MarshalEvent 

func (s *AccessDeniedException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) UnmarshalEvent 

func (s *AccessDeniedException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the AccessDeniedException value. This method is only used internally within the SDK's EventStream handling.

type ActiveContext 

type ActiveContext 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 V2 will use the current
	// list of contexts for the session. If you specify an empty list, all contexts
	// for the session are cleared.
	//
	// ContextAttributes is a required field
	ContextAttributes map[string]*string `locationName:"contextAttributes" type:"map" required:"true"`

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

	// Indicates the number of turns or seconds that the context is active. Once
	// the time to live expires, the context is no longer returned in a response.
	//
	// TimeToLive is a required field
	TimeToLive *ActiveContextTimeToLive `locationName:"timeToLive" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains information about the contexts that a user is using in a session. You can configure Amazon Lex V2 to set a context when an intent is fulfilled, or you can set a context using the , , or operations.

Use a context to indicate to Amazon Lex V2 intents that should be used as follow-up intents. For example, if the active context is order-fulfilled, only intents that have order-fulfilled configured as a trigger are considered for follow up.

func (ActiveContext) GoString 

func (s ActiveContext) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActiveContext) SetContextAttributes 

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

SetContextAttributes sets the ContextAttributes field's value.

func (*ActiveContext) SetName 

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

SetName sets the Name field's value.

func (*ActiveContext) SetTimeToLive 

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

SetTimeToLive sets the TimeToLive field's value.

func (ActiveContext) String 

func (s ActiveContext) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActiveContext) Validate 

func (s *ActiveContext) Validate() error

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

type ActiveContextTimeToLive 

type ActiveContextTimeToLive struct {

	// The number of seconds that the context is active. You can specify between
	// 5 and 86400 seconds (24 hours).
	//
	// TimeToLiveInSeconds is a required field
	TimeToLiveInSeconds *int64 `locationName:"timeToLiveInSeconds" min:"5" type:"integer" required:"true"`

	// The number of turns that the context is active. You can specify up to 20
	// turns. Each request and response from the bot is a turn.
	//
	// TurnsToLive is a required field
	TurnsToLive *int64 `locationName:"turnsToLive" min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The time that a context is active. You can specify the time to live in seconds or in conversation turns.

func (ActiveContextTimeToLive) GoString 

func (s ActiveContextTimeToLive) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActiveContextTimeToLive) SetTimeToLiveInSeconds 

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

SetTimeToLiveInSeconds sets the TimeToLiveInSeconds field's value.

func (*ActiveContextTimeToLive) SetTurnsToLive 

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

SetTurnsToLive sets the TurnsToLive field's value.

func (ActiveContextTimeToLive) String 

func (s ActiveContextTimeToLive) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActiveContextTimeToLive) Validate 

func (s *ActiveContextTimeToLive) Validate() error

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

type AudioInputEvent 

type AudioInputEvent struct {

	// An encoded stream of audio.
	// AudioChunk is automatically base64 encoded/decoded by the SDK.
	AudioChunk []byte `locationName:"audioChunk" type:"blob"`

	// A timestamp set by the client of the date and time that the event was sent
	// to Amazon Lex V2.
	ClientTimestampMillis *int64 `locationName:"clientTimestampMillis" type:"long"`

	// The encoding used for the audio chunk. You must use 8 KHz PCM 16-bit mono-channel
	// little-endian format. The value of the field should be:
	//
	// audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
	//
	// ContentType is a required field
	ContentType *string `locationName:"contentType" min:"1" type:"string" required:"true"`

	// A unique identifier that your application assigns to the event. You can use
	// this to identify events in logs.
	EventId *string `locationName:"eventId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Represents a chunk of audio sent from the client application to Amazon Lex V2. The audio is all or part of an utterance from the user.

Amazon Lex V2 accumulates audio chunks until it recognizes a natural pause in speech before processing the input.

func (AudioInputEvent) GoString 

func (s AudioInputEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudioInputEvent) MarshalEvent 

func (s *AudioInputEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*AudioInputEvent) SetAudioChunk 

func (s *AudioInputEvent) SetAudioChunk(v []byte) *AudioInputEvent

SetAudioChunk sets the AudioChunk field's value.

func (*AudioInputEvent) SetClientTimestampMillis 

func (s *AudioInputEvent) SetClientTimestampMillis(v int64) *AudioInputEvent

SetClientTimestampMillis sets the ClientTimestampMillis field's value.

func (*AudioInputEvent) SetContentType 

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

SetContentType sets the ContentType field's value.

func (*AudioInputEvent) SetEventId 

func (s *AudioInputEvent) SetEventId(v string) *AudioInputEvent

SetEventId sets the EventId field's value.

func (AudioInputEvent) String 

func (s AudioInputEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudioInputEvent) UnmarshalEvent 

func (s *AudioInputEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the AudioInputEvent value. This method is only used internally within the SDK's EventStream handling.

type AudioResponseEvent 

type AudioResponseEvent struct {

	// A chunk of the audio to play.
	// AudioChunk is automatically base64 encoded/decoded by the SDK.
	AudioChunk []byte `locationName:"audioChunk" type:"blob"`

	// The encoding of the audio chunk. This is the same as the encoding configure
	// in the contentType field of the ConfigurationEvent.
	ContentType *string `locationName:"contentType" min:"1" type:"string"`

	// A unique identifier of the event sent by Amazon Lex V2. The identifier is
	// in the form RESPONSE-N, where N is a number starting with one and incremented
	// for each event sent by Amazon Lex V2 in the current session.
	EventId *string `locationName:"eventId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

An event sent from Amazon Lex V2 to your client application containing audio to play to the user.

func (AudioResponseEvent) GoString 

func (s AudioResponseEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudioResponseEvent) MarshalEvent 

func (s *AudioResponseEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*AudioResponseEvent) SetAudioChunk 

func (s *AudioResponseEvent) SetAudioChunk(v []byte) *AudioResponseEvent

SetAudioChunk sets the AudioChunk field's value.

func (*AudioResponseEvent) SetContentType 

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

SetContentType sets the ContentType field's value.

func (*AudioResponseEvent) SetEventId 

func (s *AudioResponseEvent) SetEventId(v string) *AudioResponseEvent

SetEventId sets the EventId field's value.

func (AudioResponseEvent) String 

func (s AudioResponseEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudioResponseEvent) UnmarshalEvent 

func (s *AudioResponseEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the AudioResponseEvent value. This method is only used internally within the SDK's EventStream handling.

type BadGatewayException 

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

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

func (*BadGatewayException) Code 

func (s *BadGatewayException) Code() string

Code returns the exception type name.

func (*BadGatewayException) Error 

func (s *BadGatewayException) Error() string

func (BadGatewayException) GoString 

func (s BadGatewayException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadGatewayException) MarshalEvent 

func (s *BadGatewayException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*BadGatewayException) Message 

func (s *BadGatewayException) Message() string

Message returns the exception's message.

func (*BadGatewayException) OrigErr 

func (s *BadGatewayException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadGatewayException) RequestID 

func (s *BadGatewayException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadGatewayException) StatusCode 

func (s *BadGatewayException) StatusCode() int

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

func (BadGatewayException) String 

func (s BadGatewayException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadGatewayException) UnmarshalEvent 

func (s *BadGatewayException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the BadGatewayException value. This method is only used internally within the SDK's EventStream handling.

type Button 

type Button struct {

	// The text that is displayed on the button.
	//
	// Text is a required field
	Text *string `locationName:"text" min:"1" type:"string" required:"true"`

	// The value returned to Amazon Lex V2 when a user chooses the button.
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A button that appears on a response card show to the user.

func (Button) GoString 

func (s Button) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Button) Validate 

func (s *Button) Validate() error

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

type ConfidenceScore 

type ConfidenceScore struct {

	// A score that indicates how confident Amazon Lex V2 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 V2 has that an intent is the one that satisfies the user's intent.

func (ConfidenceScore) GoString 

func (s ConfidenceScore) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfidenceScore) SetScore 

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

SetScore sets the Score field's value.

func (ConfidenceScore) String 

func (s ConfidenceScore) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConfigurationEvent 

type ConfigurationEvent struct {

	// A timestamp set by the client of the date and time that the event was sent
	// to Amazon Lex V2.
	ClientTimestampMillis *int64 `locationName:"clientTimestampMillis" type:"long"`

	// Determines whether Amazon Lex V2 should send audio responses to the client
	// application.
	//
	// Set this field to false when the client is operating in a playback mode where
	// audio responses are played to the user. If the client isn't operating in
	// playback mode, such as a text chat application, set this to true so that
	// Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.
	DisablePlayback *bool `locationName:"disablePlayback" type:"boolean"`

	// A unique identifier that your application assigns to the event. You can use
	// this to identify events in logs.
	EventId *string `locationName:"eventId" min:"2" type:"string"`

	// Request-specific information passed between the client application and Amazon
	// Lex V2.
	//
	// The namespace x-amz-lex: is reserved for special attributes. Don't create
	// any request attributes for prefix x-amz-lex:.
	RequestAttributes map[string]*string `locationName:"requestAttributes" type:"map"`

	// The message that Amazon Lex V2 returns in the response can be either text
	// or speech based on the responseContentType value.
	//
	//    * If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text
	//    in the response.
	//
	//    * If the value begins with audio/, Amazon Lex V2 returns speech in the
	//    response. Amazon Lex V2 uses Amazon Polly to generate the speech using
	//    the configuration that you specified in the requestContentType parameter.
	//    For example, if you specify audio/mpeg as the value, Amazon Lex V2 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
	//    audio/* (defaults to mpeg) text/plain; charset=utf-8
	//
	// ResponseContentType is a required field
	ResponseContentType *string `locationName:"responseContentType" min:"1" type:"string" required:"true"`

	// The state of the user's session with Amazon Lex V2.
	SessionState *SessionState `locationName:"sessionState" type:"structure"`

	// A list of messages to send to the user.
	//
	// If you set the welcomeMessage field, you must also set the DialogAction (https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html)
	// structure's type (https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html#lexv2-Type-runtime_DialogAction-type)
	// field.
	WelcomeMessages []*Message `locationName:"welcomeMessages" type:"list"`
	// contains filtered or unexported fields
}

The initial event sent from the application to Amazon Lex V2 to configure the conversation, including session and request attributes and the response content type.

func (ConfigurationEvent) GoString 

func (s ConfigurationEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfigurationEvent) MarshalEvent 

func (s *ConfigurationEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ConfigurationEvent) SetClientTimestampMillis 

func (s *ConfigurationEvent) SetClientTimestampMillis(v int64) *ConfigurationEvent

SetClientTimestampMillis sets the ClientTimestampMillis field's value.

func (*ConfigurationEvent) SetDisablePlayback 

func (s *ConfigurationEvent) SetDisablePlayback(v bool) *ConfigurationEvent

SetDisablePlayback sets the DisablePlayback field's value.

func (*ConfigurationEvent) SetEventId 

func (s *ConfigurationEvent) SetEventId(v string) *ConfigurationEvent

SetEventId sets the EventId field's value.

func (*ConfigurationEvent) SetRequestAttributes 

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

SetRequestAttributes sets the RequestAttributes field's value.

func (*ConfigurationEvent) SetResponseContentType 

func (s *ConfigurationEvent) SetResponseContentType(v string) *ConfigurationEvent

SetResponseContentType sets the ResponseContentType field's value.

func (*ConfigurationEvent) SetSessionState 

func (s *ConfigurationEvent) SetSessionState(v *SessionState) *ConfigurationEvent

SetSessionState sets the SessionState field's value.

func (*ConfigurationEvent) SetWelcomeMessages 

func (s *ConfigurationEvent) SetWelcomeMessages(v []*Message) *ConfigurationEvent

SetWelcomeMessages sets the WelcomeMessages field's value.

func (ConfigurationEvent) String 

func (s ConfigurationEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfigurationEvent) UnmarshalEvent 

func (s *ConfigurationEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ConfigurationEvent value. This method is only used internally within the SDK's EventStream handling.

type ConflictException 

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

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

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) MarshalEvent 

func (s *ConflictException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) UnmarshalEvent 

func (s *ConflictException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ConflictException value. This method is only used internally within the SDK's EventStream handling.

type DTMFInputEvent 

type DTMFInputEvent struct {

	// A timestamp set by the client of the date and time that the event was sent
	// to Amazon Lex V2.
	ClientTimestampMillis *int64 `locationName:"clientTimestampMillis" type:"long"`

	// A unique identifier that your application assigns to the event. You can use
	// this to identify events in logs.
	EventId *string `locationName:"eventId" min:"2" type:"string"`

	// The DTMF character that the user pressed. The allowed characters are A -
	// D, 0 - 9, # and *.
	//
	// InputCharacter is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DTMFInputEvent's
	// String and GoString methods.
	//
	// InputCharacter is a required field
	InputCharacter *string `locationName:"inputCharacter" min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

A DTMF character sent from the client application. DTMF characters are typically sent from a phone keypad to represent numbers. For example, you can have Amazon Lex V2 process a credit card number input from a phone.

func (DTMFInputEvent) GoString 

func (s DTMFInputEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DTMFInputEvent) MarshalEvent 

func (s *DTMFInputEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*DTMFInputEvent) SetClientTimestampMillis 

func (s *DTMFInputEvent) SetClientTimestampMillis(v int64) *DTMFInputEvent

SetClientTimestampMillis sets the ClientTimestampMillis field's value.

func (*DTMFInputEvent) SetEventId 

func (s *DTMFInputEvent) SetEventId(v string) *DTMFInputEvent

SetEventId sets the EventId field's value.

func (*DTMFInputEvent) SetInputCharacter 

func (s *DTMFInputEvent) SetInputCharacter(v string) *DTMFInputEvent

SetInputCharacter sets the InputCharacter field's value.

func (DTMFInputEvent) String 

func (s DTMFInputEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DTMFInputEvent) UnmarshalEvent 

func (s *DTMFInputEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the DTMFInputEvent value. This method is only used internally within the SDK's EventStream handling.

type DeleteSessionInput 

type DeleteSessionInput struct {

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

	// The identifier of the bot that contains the session data.
	//
	// BotId is a required field
	BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"`

	// The locale where the session is in use.
	//
	// LocaleId is a required field
	LocaleId *string `location:"uri" locationName:"localeId" min:"1" type:"string" required:"true"`

	// The identifier of the session to delete.
	//
	// SessionId is a required field
	SessionId *string `location:"uri" locationName:"sessionId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSessionInput) GoString 

func (s DeleteSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSessionInput) SetBotAliasId 

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

SetBotAliasId sets the BotAliasId field's value.

func (*DeleteSessionInput) SetBotId 

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

SetBotId sets the BotId field's value.

func (*DeleteSessionInput) SetLocaleId 

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

SetLocaleId sets the LocaleId field's value.

func (*DeleteSessionInput) SetSessionId 

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

SetSessionId sets the SessionId field's value.

func (DeleteSessionInput) String 

func (s DeleteSessionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSessionInput) Validate 

func (s *DeleteSessionInput) Validate() error

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

type DeleteSessionOutput 

type DeleteSessionOutput struct {

	// The alias identifier in use for the bot that contained the session data.
	BotAliasId *string `locationName:"botAliasId" type:"string"`

	// The identifier of the bot that contained the session data.
	BotId *string `locationName:"botId" min:"10" type:"string"`

	// The locale where the session was used.
	LocaleId *string `locationName:"localeId" min:"1" type:"string"`

	// The identifier of the deleted session.
	SessionId *string `locationName:"sessionId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteSessionOutput) GoString 

func (s DeleteSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSessionOutput) SetBotAliasId 

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

SetBotAliasId sets the BotAliasId field's value.

func (*DeleteSessionOutput) SetBotId 

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

SetBotId sets the BotId field's value.

func (*DeleteSessionOutput) SetLocaleId 

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

SetLocaleId sets the LocaleId field's value.

func (*DeleteSessionOutput) SetSessionId 

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

SetSessionId sets the SessionId field's value.

func (DeleteSessionOutput) String 

func (s DeleteSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DependencyFailedException 

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

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

func (*DependencyFailedException) Code 

func (s *DependencyFailedException) Code() string

Code returns the exception type name.

func (*DependencyFailedException) Error 

func (s *DependencyFailedException) Error() string

func (DependencyFailedException) GoString 

func (s DependencyFailedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DependencyFailedException) MarshalEvent 

func (s *DependencyFailedException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*DependencyFailedException) Message 

func (s *DependencyFailedException) Message() string

Message returns the exception's message.

func (*DependencyFailedException) OrigErr 

func (s *DependencyFailedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DependencyFailedException) RequestID 

func (s *DependencyFailedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DependencyFailedException) StatusCode 

func (s *DependencyFailedException) StatusCode() int

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

func (DependencyFailedException) String 

func (s DependencyFailedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DependencyFailedException) UnmarshalEvent 

func (s *DependencyFailedException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the DependencyFailedException value. This method is only used internally within the SDK's EventStream handling.

type DialogAction 

type DialogAction struct {

	// Configures the slot to use spell-by-letter or spell-by-word style. When you
	// use a style on a slot, users can spell out their input to make it clear to
	// your bot.
	//
	//    * Spell by letter - "b" "o" "b"
	//
	//    * Spell by word - "b as in boy" "o as in oscar" "b as in boy"
	//
	// For more information, see Using spelling to enter slot values (https://docs.aws.amazon.com/lexv2/latest/dg/using-spelling.html).
	SlotElicitationStyle *string `locationName:"slotElicitationStyle" type:"string" enum:"StyleType"`

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

	// The name of the constituent sub slot of the composite slot specified in slotToElicit
	// that should be elicited from the user.
	SubSlotToElicit *ElicitSubSlot `locationName:"subSlotToElicit" type:"structure"`

	// The next action that the bot should take in its interaction with the user.
	// The possible values are:
	//
	//    * Close - Indicates that there will not be a response from the user. For
	//    example, the statement "Your order has been placed" does not require a
	//    response.
	//
	//    * 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?"
	//
	//    * Delegate - The next action is determined by Amazon Lex V2.
	//
	//    * ElicitIntent - The next action is to elicit an intent from the user.
	//
	//    * 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
}

The next action that Amazon Lex V2 should take.

func (DialogAction) GoString 

func (s DialogAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DialogAction) SetSlotElicitationStyle added in v1.42.9 

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

SetSlotElicitationStyle sets the SlotElicitationStyle field's value.

func (*DialogAction) SetSlotToElicit 

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

SetSlotToElicit sets the SlotToElicit field's value.

func (*DialogAction) SetSubSlotToElicit added in v1.42.9 

func (s *DialogAction) SetSubSlotToElicit(v *ElicitSubSlot) *DialogAction

SetSubSlotToElicit sets the SubSlotToElicit field's value.

func (*DialogAction) SetType 

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

SetType sets the Type field's value.

func (DialogAction) String 

func (s DialogAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DialogAction) Validate 

func (s *DialogAction) Validate() error

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

type DisconnectionEvent 

type DisconnectionEvent struct {

	// A timestamp set by the client of the date and time that the event was sent
	// to Amazon Lex V2.
	ClientTimestampMillis *int64 `locationName:"clientTimestampMillis" type:"long"`

	// A unique identifier that your application assigns to the event. You can use
	// this to identify events in logs.
	EventId *string `locationName:"eventId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

A notification from the client that it is disconnecting from Amazon Lex V2. Sending a DisconnectionEvent event is optional, but can help identify a conversation in logs.

func (DisconnectionEvent) GoString 

func (s DisconnectionEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisconnectionEvent) MarshalEvent 

func (s *DisconnectionEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*DisconnectionEvent) SetClientTimestampMillis 

func (s *DisconnectionEvent) SetClientTimestampMillis(v int64) *DisconnectionEvent

SetClientTimestampMillis sets the ClientTimestampMillis field's value.

func (*DisconnectionEvent) SetEventId 

func (s *DisconnectionEvent) SetEventId(v string) *DisconnectionEvent

SetEventId sets the EventId field's value.

func (DisconnectionEvent) String 

func (s DisconnectionEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisconnectionEvent) UnmarshalEvent 

func (s *DisconnectionEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the DisconnectionEvent value. This method is only used internally within the SDK's EventStream handling.

type ElicitSubSlot added in v1.42.9 

type ElicitSubSlot struct {

	// The name of the slot that should be elicited from the user.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The field is not supported.
	SubSlotToElicit *ElicitSubSlot `locationName:"subSlotToElicit" type:"structure"`
	// contains filtered or unexported fields
}

The specific constituent sub slot of the composite slot to elicit in dialog action.

func (ElicitSubSlot) GoString added in v1.42.9 

func (s ElicitSubSlot) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ElicitSubSlot) SetName added in v1.42.9 

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

SetName sets the Name field's value.

func (*ElicitSubSlot) SetSubSlotToElicit added in v1.42.9 

func (s *ElicitSubSlot) SetSubSlotToElicit(v *ElicitSubSlot) *ElicitSubSlot

SetSubSlotToElicit sets the SubSlotToElicit field's value.

func (ElicitSubSlot) String added in v1.42.9 

func (s ElicitSubSlot) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ElicitSubSlot) Validate added in v1.42.9 

func (s *ElicitSubSlot) Validate() error

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

type GetSessionInput 

type GetSessionInput struct {

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

	// The identifier of the bot that contains the session data.
	//
	// BotId is a required field
	BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"`

	// The locale where the session is in use.
	//
	// LocaleId is a required field
	LocaleId *string `location:"uri" locationName:"localeId" min:"1" type:"string" required:"true"`

	// The identifier of the session to return.
	//
	// SessionId is a required field
	SessionId *string `location:"uri" locationName:"sessionId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSessionInput) GoString 

func (s GetSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSessionInput) SetBotAliasId 

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

SetBotAliasId sets the BotAliasId field's value.

func (*GetSessionInput) SetBotId 

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

SetBotId sets the BotId field's value.

func (*GetSessionInput) SetLocaleId 

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

SetLocaleId sets the LocaleId field's value.

func (*GetSessionInput) SetSessionId 

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

SetSessionId sets the SessionId field's value.

func (GetSessionInput) String 

func (s GetSessionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSessionInput) Validate 

func (s *GetSessionInput) Validate() error

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

type GetSessionOutput 

type GetSessionOutput struct {

	// A list of intents that Amazon Lex V2 determined might satisfy the user's
	// utterance.
	//
	// Each interpretation includes the intent, a score that indicates how confident
	// Amazon Lex V2 is that the interpretation is the correct one, and an optional
	// sentiment response that indicates the sentiment expressed in the utterance.
	Interpretations []*Interpretation `locationName:"interpretations" type:"list"`

	// A list of messages that were last sent to the user. The messages are ordered
	// based on the order that your returned the messages from your Lambda function
	// or the order that messages are defined in the bot.
	Messages []*Message `locationName:"messages" type:"list"`

	// The identifier of the returned session.
	SessionId *string `locationName:"sessionId" min:"1" type:"string"`

	// Represents the current state of the dialog between the user and the bot.
	//
	// You can use this to determine the progress of the conversation and what the
	// next action might be.
	SessionState *SessionState `locationName:"sessionState" type:"structure"`
	// contains filtered or unexported fields
}

func (GetSessionOutput) GoString 

func (s GetSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSessionOutput) SetInterpretations 

func (s *GetSessionOutput) SetInterpretations(v []*Interpretation) *GetSessionOutput

SetInterpretations sets the Interpretations field's value.

func (*GetSessionOutput) SetMessages 

func (s *GetSessionOutput) SetMessages(v []*Message) *GetSessionOutput

SetMessages sets the Messages field's value.

func (*GetSessionOutput) SetSessionId 

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

SetSessionId sets the SessionId field's value.

func (*GetSessionOutput) SetSessionState 

func (s *GetSessionOutput) SetSessionState(v *SessionState) *GetSessionOutput

SetSessionState sets the SessionState field's value.

func (GetSessionOutput) String 

func (s GetSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HeartbeatEvent 

type HeartbeatEvent struct {

	// A unique identifier of the event sent by Amazon Lex V2. The identifier is
	// in the form RESPONSE-N, where N is a number starting with one and incremented
	// for each event sent by Amazon Lex V2 in the current session.
	EventId *string `locationName:"eventId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Event that Amazon Lex V2 sends to indicate that the stream is still open between the client application and Amazon Lex V2

func (HeartbeatEvent) GoString 

func (s HeartbeatEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HeartbeatEvent) MarshalEvent 

func (s *HeartbeatEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*HeartbeatEvent) SetEventId 

func (s *HeartbeatEvent) SetEventId(v string) *HeartbeatEvent

SetEventId sets the EventId field's value.

func (HeartbeatEvent) String 

func (s HeartbeatEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HeartbeatEvent) UnmarshalEvent 

func (s *HeartbeatEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the HeartbeatEvent value. This method is only used internally within the SDK's EventStream handling.

type ImageResponseCard 

type ImageResponseCard struct {

	// A list of buttons that should be displayed on the response card. The arrangement
	// of the buttons is determined by the platform that displays the button.
	Buttons []*Button `locationName:"buttons" type:"list"`

	// The URL of an image to display on the response card. The image URL must be
	// publicly available so that the platform displaying the response card has
	// access to the image.
	ImageUrl *string `locationName:"imageUrl" min:"1" type:"string"`

	// The subtitle to display on the response card. The format of the subtitle
	// is determined by the platform displaying the response card.
	Subtitle *string `locationName:"subtitle" min:"1" type:"string"`

	// The title to display on the response card. The format of the title is determined
	// by the platform displaying the response card.
	//
	// Title is a required field
	Title *string `locationName:"title" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.

When you use a response card, the response from the user is constrained to the text associated with a button on the card.

func (ImageResponseCard) GoString 

func (s ImageResponseCard) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImageResponseCard) SetButtons 

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

SetButtons sets the Buttons field's value.

func (*ImageResponseCard) SetImageUrl 

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

SetImageUrl sets the ImageUrl field's value.

func (*ImageResponseCard) SetSubtitle 

func (s *ImageResponseCard) SetSubtitle(v string) *ImageResponseCard

SetSubtitle sets the Subtitle field's value.

func (*ImageResponseCard) SetTitle 

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

SetTitle sets the Title field's value.

func (ImageResponseCard) String 

func (s ImageResponseCard) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImageResponseCard) Validate 

func (s *ImageResponseCard) Validate() error

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

type Intent 

type Intent struct {

	// Contains information about whether fulfillment of the intent has been confirmed.
	ConfirmationState *string `locationName:"confirmationState" type:"string" enum:"ConfirmationState"`

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

	// A map of all of the slots for the intent. The name of the slot maps to the
	// value of the slot. If a slot has not been filled, the value is null.
	Slots map[string]*Slot `locationName:"slots" type:"map"`

	// Contains fulfillment information for the intent.
	State *string `locationName:"state" type:"string" enum:"IntentState"`
	// contains filtered or unexported fields
}

The current intent that Amazon Lex V2 is attempting to fulfill.

func (Intent) GoString 

func (s Intent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Intent) SetConfirmationState 

func (s *Intent) SetConfirmationState(v string) *Intent

SetConfirmationState sets the ConfirmationState field's value.

func (*Intent) SetName 

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

SetName sets the Name field's value.

func (*Intent) SetSlots 

func (s *Intent) SetSlots(v map[string]*Slot) *Intent

SetSlots sets the Slots field's value.

func (*Intent) SetState 

func (s *Intent) SetState(v string) *Intent

SetState sets the State field's value.

func (Intent) String 

func (s Intent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Intent) Validate 

func (s *Intent) Validate() error

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

type IntentResultEvent 

type IntentResultEvent struct {

	// A unique identifier of the event sent by Amazon Lex V2. The identifier is
	// in the form RESPONSE-N, where N is a number starting with one and incremented
	// for each event sent by Amazon Lex V2 in the current session.
	EventId *string `locationName:"eventId" min:"2" type:"string"`

	// Indicates whether the input to the operation was text or speech.
	InputMode *string `locationName:"inputMode" type:"string" enum:"InputMode"`

	// A list of intents that Amazon Lex V2 determined might satisfy the user's
	// utterance.
	//
	// Each interpretation includes the intent, a score that indicates how confident
	// Amazon Lex V2 is that the interpretation is the correct one, and an optional
	// sentiment response that indicates the sentiment expressed in the utterance.
	Interpretations []*Interpretation `locationName:"interpretations" type:"list"`

	// The bot member that is processing the intent.
	RecognizedBotMember *RecognizedBotMember `locationName:"recognizedBotMember" type:"structure"`

	// The attributes sent in the request.
	RequestAttributes map[string]*string `locationName:"requestAttributes" type:"map"`

	// The identifier of the session in use.
	SessionId *string `locationName:"sessionId" min:"2" type:"string"`

	// The state of the user's session with Amazon Lex V2.
	SessionState *SessionState `locationName:"sessionState" type:"structure"`
	// contains filtered or unexported fields
}

Contains the current state of the conversation between the client application and Amazon Lex V2.

func (IntentResultEvent) GoString 

func (s IntentResultEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IntentResultEvent) MarshalEvent 

func (s *IntentResultEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*IntentResultEvent) SetEventId 

func (s *IntentResultEvent) SetEventId(v string) *IntentResultEvent

SetEventId sets the EventId field's value.

func (*IntentResultEvent) SetInputMode 

func (s *IntentResultEvent) SetInputMode(v string) *IntentResultEvent

SetInputMode sets the InputMode field's value.

func (*IntentResultEvent) SetInterpretations 

func (s *IntentResultEvent) SetInterpretations(v []*Interpretation) *IntentResultEvent

SetInterpretations sets the Interpretations field's value.

func (*IntentResultEvent) SetRecognizedBotMember added in v1.42.9 

func (s *IntentResultEvent) SetRecognizedBotMember(v *RecognizedBotMember) *IntentResultEvent

SetRecognizedBotMember sets the RecognizedBotMember field's value.

func (*IntentResultEvent) SetRequestAttributes 

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

SetRequestAttributes sets the RequestAttributes field's value.

func (*IntentResultEvent) SetSessionId 

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

SetSessionId sets the SessionId field's value.

func (*IntentResultEvent) SetSessionState 

func (s *IntentResultEvent) SetSessionState(v *SessionState) *IntentResultEvent

SetSessionState sets the SessionState field's value.

func (IntentResultEvent) String 

func (s IntentResultEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IntentResultEvent) UnmarshalEvent 

func (s *IntentResultEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the IntentResultEvent value. This method is only used internally within the SDK's EventStream handling.

type InternalServerException 

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

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

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) MarshalEvent 

func (s *InternalServerException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) UnmarshalEvent 

func (s *InternalServerException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the InternalServerException value. This method is only used internally within the SDK's EventStream handling.

type Interpretation 

type Interpretation struct {

	// A list of intents that might satisfy the user's utterance. The intents are
	// ordered by the confidence score.
	Intent *Intent `locationName:"intent" type:"structure"`

	// Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent,
	// AMAZON.KendraSearchIntent, or both when returning alternative intents in
	// a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only
	// inserted if they are configured for the bot.
	NluConfidence *ConfidenceScore `locationName:"nluConfidence" type:"structure"`

	// 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 *SentimentResponse `locationName:"sentimentResponse" type:"structure"`
	// contains filtered or unexported fields
}

An intent that Amazon Lex V2 determined might satisfy the user's utterance. The intents are ordered by the confidence score.

func (Interpretation) GoString 

func (s Interpretation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Interpretation) SetIntent 

func (s *Interpretation) SetIntent(v *Intent) *Interpretation

SetIntent sets the Intent field's value.

func (*Interpretation) SetNluConfidence 

func (s *Interpretation) SetNluConfidence(v *ConfidenceScore) *Interpretation

SetNluConfidence sets the NluConfidence field's value.

func (*Interpretation) SetSentimentResponse 

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

SetSentimentResponse sets the SentimentResponse field's value.

func (Interpretation) String 

func (s Interpretation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LexRuntimeV2 

type LexRuntimeV2 struct {
	*client.Client
}

LexRuntimeV2 provides the API operation methods for making requests to Amazon Lex Runtime V2. See this package's package overview docs for details on the service.

LexRuntimeV2 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) *LexRuntimeV2

New creates a new instance of the LexRuntimeV2 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 LexRuntimeV2 client from just a session.
svc := lexruntimev2.New(mySession)

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

func (*LexRuntimeV2) DeleteSession 

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

DeleteSession API operation for Amazon Lex Runtime V2.

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

You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.

You don't need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.

If you specify a bot or alias ID that doesn't exist, you receive a BadRequestException.

If the locale doesn't exist in the bot, or if the locale hasn't been enables for the alias, you receive a BadRequestException.

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 V2's API operation DeleteSession for usage and error information.

Returned Error Types:

  • AccessDeniedException

  • ResourceNotFoundException

  • ValidationException

  • ThrottlingException

  • InternalServerException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/DeleteSession

func (*LexRuntimeV2) DeleteSessionRequest 

func (c *LexRuntimeV2) 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.v2-2020-08-07/DeleteSession

func (*LexRuntimeV2) DeleteSessionWithContext 

func (c *LexRuntimeV2) 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 (*LexRuntimeV2) GetSession 

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

GetSession API operation for Amazon Lex Runtime V2.

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

For example, you can use this operation to retrieve session information for a user that has left a long-running session in use.

If the bot, alias, or session identifier doesn't exist, Amazon Lex V2 returns a BadRequestException. If the locale doesn't exist or is not enabled for the alias, you receive a BadRequestException.

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 V2's API operation GetSession for usage and error information.

Returned Error Types:

  • AccessDeniedException

  • ResourceNotFoundException

  • ValidationException

  • ThrottlingException

  • InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/GetSession

func (*LexRuntimeV2) GetSessionRequest 

func (c *LexRuntimeV2) 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.v2-2020-08-07/GetSession

func (*LexRuntimeV2) GetSessionWithContext 

func (c *LexRuntimeV2) 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 (*LexRuntimeV2) PutSession 

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

PutSession API operation for Amazon Lex Runtime V2.

Creates a new session or modifies an existing session with an Amazon Lex V2 bot. Use this operation to enable your application to set the state of the bot.

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 V2's API operation PutSession for usage and error information.

Returned Error Types:

  • AccessDeniedException

  • ResourceNotFoundException

  • ValidationException

  • ThrottlingException

  • InternalServerException

  • ConflictException

  • DependencyFailedException

  • BadGatewayException

See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/PutSession

func (*LexRuntimeV2) PutSessionRequest 

func (c *LexRuntimeV2) 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.v2-2020-08-07/PutSession

func (*LexRuntimeV2) PutSessionWithContext 

func (c *LexRuntimeV2) 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.

func (*LexRuntimeV2) RecognizeText 

func (c *LexRuntimeV2) RecognizeText(input *RecognizeTextInput) (*RecognizeTextOutput, error)

RecognizeText API operation for Amazon Lex Runtime V2.

Sends user input to Amazon Lex V2. Client applications use this API to send requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input using the machine learning model that it build for the bot.

In response, Amazon Lex V2 returns the next message to convey to the user and an optional response card to display.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification (https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html).

  • Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

  • Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

  • Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.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 V2's API operation RecognizeText for usage and error information.

Returned Error Types:

  • AccessDeniedException

  • ResourceNotFoundException

  • ValidationException

  • ThrottlingException

  • InternalServerException

  • ConflictException

  • DependencyFailedException

  • BadGatewayException

See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/RecognizeText

func (*LexRuntimeV2) RecognizeTextRequest 

func (c *LexRuntimeV2) RecognizeTextRequest(input *RecognizeTextInput) (req *request.Request, output *RecognizeTextOutput)

RecognizeTextRequest generates a "aws/request.Request" representing the client's request for the RecognizeText 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 RecognizeText for more information on using the RecognizeText 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 RecognizeTextRequest method.
req, resp := client.RecognizeTextRequest(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.v2-2020-08-07/RecognizeText

func (*LexRuntimeV2) RecognizeTextWithContext 

func (c *LexRuntimeV2) RecognizeTextWithContext(ctx aws.Context, input *RecognizeTextInput, opts ...request.Option) (*RecognizeTextOutput, error)

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

See RecognizeText 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 (*LexRuntimeV2) RecognizeUtterance 

func (c *LexRuntimeV2) RecognizeUtterance(input *RecognizeUtteranceInput) (*RecognizeUtteranceOutput, error)

RecognizeUtterance API operation for Amazon Lex Runtime V2.

Sends user input to Amazon Lex V2. You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 interprets the user input using the machine learning model built for the bot.

The following request fields must be compressed with gzip and then base64 encoded before you send them to Amazon Lex V2.

  • requestAttributes

  • sessionState

The following response fields are compressed using gzip and then base64 encoded by Amazon Lex V2. Before you can use these fields, you must decode and decompress them.

  • inputTranscript

  • interpretations

  • messages

  • requestAttributes

  • sessionState

The example contains a Java application that compresses and encodes a Java object to send to Amazon Lex V2, and a second that decodes and decompresses a response from Amazon Lex V2.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification (https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html).

  • Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

  • Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

  • Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.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 V2's API operation RecognizeUtterance for usage and error information.

Returned Error Types:

  • AccessDeniedException

  • ResourceNotFoundException

  • ValidationException

  • ThrottlingException

  • InternalServerException

  • ConflictException

  • DependencyFailedException

  • BadGatewayException

See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/RecognizeUtterance

func (*LexRuntimeV2) RecognizeUtteranceRequest 

func (c *LexRuntimeV2) RecognizeUtteranceRequest(input *RecognizeUtteranceInput) (req *request.Request, output *RecognizeUtteranceOutput)

RecognizeUtteranceRequest generates a "aws/request.Request" representing the client's request for the RecognizeUtterance 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 RecognizeUtterance for more information on using the RecognizeUtterance 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 RecognizeUtteranceRequest method.
req, resp := client.RecognizeUtteranceRequest(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.v2-2020-08-07/RecognizeUtterance

func (*LexRuntimeV2) RecognizeUtteranceWithContext 

func (c *LexRuntimeV2) RecognizeUtteranceWithContext(ctx aws.Context, input *RecognizeUtteranceInput, opts ...request.Option) (*RecognizeUtteranceOutput, error)

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

See RecognizeUtterance 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 (*LexRuntimeV2) StartConversation 

func (c *LexRuntimeV2) StartConversation(input *StartConversationInput) (*StartConversationOutput, error)

StartConversation API operation for Amazon Lex Runtime V2.

Starts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time. After your application starts a conversation, users send input to Amazon Lex V2 as a stream of events. Amazon Lex V2 processes the incoming events and responds with streaming text or audio events.

Audio input must be in the following format: audio/lpcm sample-rate=8000 sample-size-bits=16 channel-count=1; is-big-endian=false.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification (https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html).

  • Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

  • Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

  • Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html).

If the optional update message is configured, it is played at the specified frequency while the Lambda function is running and the update message state is active. If the fulfillment update message is not active, the Lambda function runs with a 30 second timeout.

For more information, see Update message (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-update.html)

The StartConversation operation is supported only in the following SDKs:

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 V2's API operation StartConversation for usage and error information.

Returned Error Types:

  • AccessDeniedException

  • ValidationException

  • ThrottlingException

  • InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/StartConversation

func (*LexRuntimeV2) StartConversationRequest 

func (c *LexRuntimeV2) StartConversationRequest(input *StartConversationInput) (req *request.Request, output *StartConversationOutput)

StartConversationRequest generates a "aws/request.Request" representing the client's request for the StartConversation 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 StartConversation for more information on using the StartConversation 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 StartConversationRequest method.
req, resp := client.StartConversationRequest(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.v2-2020-08-07/StartConversation

func (*LexRuntimeV2) StartConversationWithContext 

func (c *LexRuntimeV2) StartConversationWithContext(ctx aws.Context, input *StartConversationInput, opts ...request.Option) (*StartConversationOutput, error)

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

See StartConversation 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 Message 

type Message struct {

	// The text of the message.
	//
	// Content is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Message's
	// String and GoString methods.
	Content *string `locationName:"content" min:"1" type:"string" sensitive:"true"`

	// Indicates the type of response.
	//
	// ContentType is a required field
	ContentType *string `locationName:"contentType" type:"string" required:"true" enum:"MessageContentType"`

	// A card that is shown to the user by a messaging platform. You define the
	// contents of the card, the card is displayed by the platform.
	//
	// When you use a response card, the response from the user is constrained to
	// the text associated with a button on the card.
	ImageResponseCard *ImageResponseCard `locationName:"imageResponseCard" type:"structure"`
	// contains filtered or unexported fields
}

Container for text that is returned to the customer..

func (Message) GoString 

func (s Message) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Message) SetContent 

func (s *Message) SetContent(v string) *Message

SetContent sets the Content field's value.

func (*Message) SetContentType 

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

SetContentType sets the ContentType field's value.

func (*Message) SetImageResponseCard 

func (s *Message) SetImageResponseCard(v *ImageResponseCard) *Message

SetImageResponseCard sets the ImageResponseCard field's value.

func (Message) String 

func (s Message) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Message) Validate 

func (s *Message) Validate() error

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

type PlaybackCompletionEvent 

type PlaybackCompletionEvent struct {

	// A timestamp set by the client of the date and time that the event was sent
	// to Amazon Lex V2.
	ClientTimestampMillis *int64 `locationName:"clientTimestampMillis" type:"long"`

	// A unique identifier that your application assigns to the event. You can use
	// this to identify events in logs.
	EventId *string `locationName:"eventId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Event sent from the client application to Amazon Lex V2 to indicate that playback of audio is complete and that Amazon Lex V2 should start processing the user's input.

func (PlaybackCompletionEvent) GoString 

func (s PlaybackCompletionEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlaybackCompletionEvent) MarshalEvent 

func (s *PlaybackCompletionEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*PlaybackCompletionEvent) SetClientTimestampMillis 

func (s *PlaybackCompletionEvent) SetClientTimestampMillis(v int64) *PlaybackCompletionEvent

SetClientTimestampMillis sets the ClientTimestampMillis field's value.

func (*PlaybackCompletionEvent) SetEventId 

func (s *PlaybackCompletionEvent) SetEventId(v string) *PlaybackCompletionEvent

SetEventId sets the EventId field's value.

func (PlaybackCompletionEvent) String 

func (s PlaybackCompletionEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlaybackCompletionEvent) UnmarshalEvent 

func (s *PlaybackCompletionEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the PlaybackCompletionEvent value. This method is only used internally within the SDK's EventStream handling.

type PlaybackInterruptionEvent 

type PlaybackInterruptionEvent struct {

	// The identifier of the event that contained the audio, DTMF, or text that
	// caused the interruption.
	CausedByEventId *string `locationName:"causedByEventId" min:"2" type:"string"`

	// A unique identifier of the event sent by Amazon Lex V2. The identifier is
	// in the form RESPONSE-N, where N is a number starting with one and incremented
	// for each event sent by Amazon Lex V2 in the current session.
	EventId *string `locationName:"eventId" min:"2" type:"string"`

	// Indicates the type of user input that Amazon Lex V2 detected.
	EventReason *string `locationName:"eventReason" type:"string" enum:"PlaybackInterruptionReason"`
	// contains filtered or unexported fields
}

Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.

func (PlaybackInterruptionEvent) GoString 

func (s PlaybackInterruptionEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlaybackInterruptionEvent) MarshalEvent 

func (s *PlaybackInterruptionEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*PlaybackInterruptionEvent) SetCausedByEventId 

func (s *PlaybackInterruptionEvent) SetCausedByEventId(v string) *PlaybackInterruptionEvent

SetCausedByEventId sets the CausedByEventId field's value.

func (*PlaybackInterruptionEvent) SetEventId 

func (s *PlaybackInterruptionEvent) SetEventId(v string) *PlaybackInterruptionEvent

SetEventId sets the EventId field's value.

func (*PlaybackInterruptionEvent) SetEventReason 

func (s *PlaybackInterruptionEvent) SetEventReason(v string) *PlaybackInterruptionEvent

SetEventReason sets the EventReason field's value.

func (PlaybackInterruptionEvent) String 

func (s PlaybackInterruptionEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlaybackInterruptionEvent) UnmarshalEvent 

func (s *PlaybackInterruptionEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the PlaybackInterruptionEvent value. This method is only used internally within the SDK's EventStream handling.

type PutSessionInput 

type PutSessionInput struct {

	// The alias identifier of the bot that receives the session data.
	//
	// BotAliasId is a required field
	BotAliasId *string `location:"uri" locationName:"botAliasId" type:"string" required:"true"`

	// The identifier of the bot that receives the session data.
	//
	// BotId is a required field
	BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"`

	// The locale where the session is in use.
	//
	// LocaleId is a required field
	LocaleId *string `location:"uri" locationName:"localeId" min:"1" type:"string" required:"true"`

	// A list of messages to send to the user. Messages are sent in the order that
	// they are defined in the list.
	Messages []*Message `locationName:"messages" type:"list"`

	// Request-specific information passed between Amazon Lex V2 and the client
	// application.
	//
	// The namespace x-amz-lex: is reserved for special attributes. Don't create
	// any request attributes with the prefix x-amz-lex:.
	RequestAttributes map[string]*string `locationName:"requestAttributes" type:"map"`

	// The message that Amazon Lex V2 returns in the response can be either text
	// or speech depending on the value of this parameter.
	//
	//    * If the value is text/plain; charset=utf-8, Amazon Lex V2 returns text
	//    in the response.
	ResponseContentType *string `location:"header" locationName:"ResponseContentType" min:"1" type:"string"`

	// The identifier of the session that receives the session data.
	//
	// SessionId is a required field
	SessionId *string `location:"uri" locationName:"sessionId" min:"2" type:"string" required:"true"`

	// Sets the state of the session with the user. You can use this to set the
	// current intent, attributes, context, and dialog action. Use the dialog action
	// to determine the next step that Amazon Lex V2 should use in the conversation
	// with the user.
	//
	// SessionState is a required field
	SessionState *SessionState `locationName:"sessionState" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutSessionInput) GoString 

func (s PutSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutSessionInput) SetBotAliasId 

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

SetBotAliasId sets the BotAliasId field's value.

func (*PutSessionInput) SetBotId 

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

SetBotId sets the BotId field's value.

func (*PutSessionInput) SetLocaleId 

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

SetLocaleId sets the LocaleId field's value.

func (*PutSessionInput) SetMessages 

func (s *PutSessionInput) SetMessages(v []*Message) *PutSessionInput

SetMessages sets the Messages field's value.

func (*PutSessionInput) SetRequestAttributes 

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

SetRequestAttributes sets the RequestAttributes field's value.

func (*PutSessionInput) SetResponseContentType 

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

SetResponseContentType sets the ResponseContentType field's value.

func (*PutSessionInput) SetSessionId 

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

SetSessionId sets the SessionId field's value.

func (*PutSessionInput) SetSessionState 

func (s *PutSessionInput) SetSessionState(v *SessionState) *PutSessionInput

SetSessionState sets the SessionState field's value.

func (PutSessionInput) String 

func (s PutSessionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutSessionInput) Validate 

func (s *PutSessionInput) Validate() error

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

type PutSessionOutput 

type PutSessionOutput struct {

	// If the requested content type was audio, the audio version of the message
	// to convey to the user.
	AudioStream io.ReadCloser `locationName:"audioStream" type:"blob"`

	// The type of response. Same as the type specified in the responseContentType
	// field in the request.
	ContentType *string `location:"header" locationName:"Content-Type" min:"1" type:"string"`

	// A list of messages that were last sent to the user. The messages are ordered
	// based on how you return the messages from you Lambda function or the order
	// that the messages are defined in the bot.
	Messages *string `location:"header" locationName:"x-amz-lex-messages" min:"1" type:"string"`

	// Request-specific information passed between the client application and Amazon
	// Lex V2. These are the same as the requestAttribute parameter in the call
	// to the PutSession operation.
	RequestAttributes *string `location:"header" locationName:"x-amz-lex-request-attributes" min:"1" type:"string"`

	// The identifier of the session that received the data.
	SessionId *string `location:"header" locationName:"x-amz-lex-session-id" min:"2" type:"string"`

	// Represents the current state of the dialog between the user and the bot.
	//
	// Use this to determine the progress of the conversation and what the next
	// action may be.
	SessionState *string `location:"header" locationName:"x-amz-lex-session-state" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutSessionOutput) GoString 

func (s PutSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutSessionOutput) SetAudioStream 

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

SetAudioStream sets the AudioStream field's value.

func (*PutSessionOutput) SetContentType 

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

SetContentType sets the ContentType field's value.

func (*PutSessionOutput) SetMessages 

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

SetMessages sets the Messages field's value.

func (*PutSessionOutput) SetRequestAttributes 

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

SetRequestAttributes sets the RequestAttributes field's value.

func (*PutSessionOutput) SetSessionId 

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

SetSessionId sets the SessionId field's value.

func (*PutSessionOutput) SetSessionState 

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

SetSessionState sets the SessionState field's value.

func (PutSessionOutput) String 

func (s PutSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecognizeTextInput 

type RecognizeTextInput struct {

	// The alias identifier in use for the bot that processes the request.
	//
	// BotAliasId is a required field
	BotAliasId *string `location:"uri" locationName:"botAliasId" type:"string" required:"true"`

	// The identifier of the bot that processes the request.
	//
	// BotId is a required field
	BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"`

	// The locale where the session is in use.
	//
	// LocaleId is a required field
	LocaleId *string `location:"uri" locationName:"localeId" min:"1" type:"string" required:"true"`

	// Request-specific information passed between the client application and Amazon
	// Lex V2
	//
	// The namespace x-amz-lex: is reserved for special attributes. Don't create
	// any request attributes with the prefix x-amz-lex:.
	RequestAttributes map[string]*string `locationName:"requestAttributes" type:"map"`

	// The identifier of the user session that is having the conversation.
	//
	// SessionId is a required field
	SessionId *string `location:"uri" locationName:"sessionId" min:"2" type:"string" required:"true"`

	// The current state of the dialog between the user and the bot.
	SessionState *SessionState `locationName:"sessionState" type:"structure"`

	// The text that the user entered. Amazon Lex V2 interprets this text.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RecognizeTextInput's
	// String and GoString methods.
	//
	// Text is a required field
	Text *string `locationName:"text" min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (RecognizeTextInput) GoString 

func (s RecognizeTextInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecognizeTextInput) SetBotAliasId 

func (s *RecognizeTextInput) SetBotAliasId(v string) *RecognizeTextInput

SetBotAliasId sets the BotAliasId field's value.

func (*RecognizeTextInput) SetBotId 

func (s *RecognizeTextInput) SetBotId(v string) *RecognizeTextInput

SetBotId sets the BotId field's value.

func (*RecognizeTextInput) SetLocaleId 

func (s *RecognizeTextInput) SetLocaleId(v string) *RecognizeTextInput

SetLocaleId sets the LocaleId field's value.

func (*RecognizeTextInput) SetRequestAttributes 

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

SetRequestAttributes sets the RequestAttributes field's value.

func (*RecognizeTextInput) SetSessionId 

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

SetSessionId sets the SessionId field's value.

func (*RecognizeTextInput) SetSessionState 

func (s *RecognizeTextInput) SetSessionState(v *SessionState) *RecognizeTextInput

SetSessionState sets the SessionState field's value.

func (*RecognizeTextInput) SetText 

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

SetText sets the Text field's value.

func (RecognizeTextInput) String 

func (s RecognizeTextInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecognizeTextInput) Validate 

func (s *RecognizeTextInput) Validate() error

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

type RecognizeTextOutput 

type RecognizeTextOutput struct {

	// A list of intents that Amazon Lex V2 determined might satisfy the user's
	// utterance.
	//
	// Each interpretation includes the intent, a score that indicates now confident
	// Amazon Lex V2 is that the interpretation is the correct one, and an optional
	// sentiment response that indicates the sentiment expressed in the utterance.
	Interpretations []*Interpretation `locationName:"interpretations" type:"list"`

	// A list of messages last sent to the user. The messages are ordered based
	// on the order that you returned the messages from your Lambda function or
	// the order that the messages are defined in the bot.
	Messages []*Message `locationName:"messages" type:"list"`

	// The bot member that recognized the text.
	RecognizedBotMember *RecognizedBotMember `locationName:"recognizedBotMember" type:"structure"`

	// The attributes sent in the request.
	RequestAttributes map[string]*string `locationName:"requestAttributes" type:"map"`

	// The identifier of the session in use.
	SessionId *string `locationName:"sessionId" min:"2" type:"string"`

	// Represents the current state of the dialog between the user and the bot.
	//
	// Use this to determine the progress of the conversation and what the next
	// action may be.
	SessionState *SessionState `locationName:"sessionState" type:"structure"`
	// contains filtered or unexported fields
}

func (RecognizeTextOutput) GoString 

func (s RecognizeTextOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecognizeTextOutput) SetInterpretations 

func (s *RecognizeTextOutput) SetInterpretations(v []*Interpretation) *RecognizeTextOutput

SetInterpretations sets the Interpretations field's value.

func (*RecognizeTextOutput) SetMessages 

func (s *RecognizeTextOutput) SetMessages(v []*Message) *RecognizeTextOutput

SetMessages sets the Messages field's value.

func (*RecognizeTextOutput) SetRecognizedBotMember added in v1.42.9 

func (s *RecognizeTextOutput) SetRecognizedBotMember(v *RecognizedBotMember) *RecognizeTextOutput

SetRecognizedBotMember sets the RecognizedBotMember field's value.

func (*RecognizeTextOutput) SetRequestAttributes 

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

SetRequestAttributes sets the RequestAttributes field's value.

func (*RecognizeTextOutput) SetSessionId 

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

SetSessionId sets the SessionId field's value.

func (*RecognizeTextOutput) SetSessionState 

func (s *RecognizeTextOutput) SetSessionState(v *SessionState) *RecognizeTextOutput

SetSessionState sets the SessionState field's value.

func (RecognizeTextOutput) String 

func (s RecognizeTextOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecognizeUtteranceInput 

type RecognizeUtteranceInput struct {

	// The alias identifier in use for the bot that should receive the request.
	//
	// BotAliasId is a required field
	BotAliasId *string `location:"uri" locationName:"botAliasId" type:"string" required:"true"`

	// The identifier of the bot that should receive the request.
	//
	// BotId is a required field
	BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"`

	// User input in PCM or Opus audio format or text format as described in the
	// requestContentType parameter.
	//
	// 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 io.ReadSeeker `locationName:"inputStream" type:"blob"`

	// The locale where the session is in use.
	//
	// LocaleId is a required field
	LocaleId *string `location:"uri" locationName:"localeId" min:"1" type:"string" required:"true"`

	// Request-specific information passed between the client application and Amazon
	// Lex V2
	//
	// The namespace x-amz-lex: is reserved for special attributes. Don't create
	// any request attributes for prefix x-amz-lex:.
	//
	// The requestAttributes field must be compressed using gzip and then base64
	// encoded before sending to Amazon Lex V2.
	//
	// RequestAttributes is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RecognizeUtteranceInput's
	// String and GoString methods.
	RequestAttributes *string `location:"header" locationName:"x-amz-lex-request-attributes" type:"string" sensitive:"true"`

	// Indicates the format for audio input or that the content is text. The header
	// 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
	//
	// RequestContentType is a required field
	RequestContentType *string `location:"header" locationName:"Content-Type" min:"1" type:"string" required:"true"`

	// The message that Amazon Lex V2 returns in the response can be either text
	// or speech based on the responseContentType value.
	//
	//    * If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text
	//    in the response.
	//
	//    * If the value begins with audio/, Amazon Lex V2 returns speech in the
	//    response. Amazon Lex V2 uses Amazon Polly to generate the speech using
	//    the configuration that you specified in the responseContentType parameter.
	//    For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns
	//    speech in the MPEG format.
	//
	//    * If the value is audio/pcm, the speech returned is audio/pcm at 16 KHz
	//    in 16-bit, little-endian format.
	//
	//    * The following are the accepted values: audio/mpeg audio/ogg audio/pcm
	//    (16 KHz) audio/* (defaults to mpeg) text/plain; charset=utf-8
	ResponseContentType *string `location:"header" locationName:"Response-Content-Type" min:"1" type:"string"`

	// The identifier of the session in use.
	//
	// SessionId is a required field
	SessionId *string `location:"uri" locationName:"sessionId" min:"2" type:"string" required:"true"`

	// Sets the state of the session with the user. You can use this to set the
	// current intent, attributes, context, and dialog action. Use the dialog action
	// to determine the next step that Amazon Lex V2 should use in the conversation
	// with the user.
	//
	// The sessionState field must be compressed using gzip and then base64 encoded
	// before sending to Amazon Lex V2.
	//
	// SessionState is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RecognizeUtteranceInput's
	// String and GoString methods.
	SessionState *string `location:"header" locationName:"x-amz-lex-session-state" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (RecognizeUtteranceInput) GoString 

func (s RecognizeUtteranceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecognizeUtteranceInput) SetBotAliasId 

func (s *RecognizeUtteranceInput) SetBotAliasId(v string) *RecognizeUtteranceInput

SetBotAliasId sets the BotAliasId field's value.

func (*RecognizeUtteranceInput) SetBotId 

func (s *RecognizeUtteranceInput) SetBotId(v string) *RecognizeUtteranceInput

SetBotId sets the BotId field's value.

func (*RecognizeUtteranceInput) SetInputStream 

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

SetInputStream sets the InputStream field's value.

func (*RecognizeUtteranceInput) SetLocaleId 

func (s *RecognizeUtteranceInput) SetLocaleId(v string) *RecognizeUtteranceInput

SetLocaleId sets the LocaleId field's value.

func (*RecognizeUtteranceInput) SetRequestAttributes 

func (s *RecognizeUtteranceInput) SetRequestAttributes(v string) *RecognizeUtteranceInput

SetRequestAttributes sets the RequestAttributes field's value.

func (*RecognizeUtteranceInput) SetRequestContentType 

func (s *RecognizeUtteranceInput) SetRequestContentType(v string) *RecognizeUtteranceInput

SetRequestContentType sets the RequestContentType field's value.

func (*RecognizeUtteranceInput) SetResponseContentType 

func (s *RecognizeUtteranceInput) SetResponseContentType(v string) *RecognizeUtteranceInput

SetResponseContentType sets the ResponseContentType field's value.

func (*RecognizeUtteranceInput) SetSessionId 

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

SetSessionId sets the SessionId field's value.

func (*RecognizeUtteranceInput) SetSessionState 

func (s *RecognizeUtteranceInput) SetSessionState(v string) *RecognizeUtteranceInput

SetSessionState sets the SessionState field's value.

func (RecognizeUtteranceInput) String 

func (s RecognizeUtteranceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecognizeUtteranceInput) Validate 

func (s *RecognizeUtteranceInput) Validate() error

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

type RecognizeUtteranceOutput 

type RecognizeUtteranceOutput struct {

	// The prompt or statement to send to the user. This is based on the bot configuration
	// and context. For example, if Amazon Lex V2 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 V2
	// sends that message in the response.
	AudioStream io.ReadCloser `locationName:"audioStream" type:"blob"`

	// Content type as specified in the responseContentType in the request.
	ContentType *string `location:"header" locationName:"Content-Type" min:"1" type:"string"`

	// Indicates whether the input mode to the operation was text or speech.
	InputMode *string `location:"header" locationName:"x-amz-lex-input-mode" min:"1" type:"string"`

	// The text used to process the request.
	//
	// 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 V2 is correctly processing the audio that you send.
	//
	// The inputTranscript field is compressed with gzip and then base64 encoded.
	// Before you can use the contents of the field, you must decode and decompress
	// the contents. See the example for a simple function to decode and decompress
	// the contents.
	InputTranscript *string `location:"header" locationName:"x-amz-lex-input-transcript" min:"1" type:"string"`

	// A list of intents that Amazon Lex V2 determined might satisfy the user's
	// utterance.
	//
	// Each interpretation includes the intent, a score that indicates how confident
	// Amazon Lex V2 is that the interpretation is the correct one, and an optional
	// sentiment response that indicates the sentiment expressed in the utterance.
	//
	// The interpretations field is compressed with gzip and then base64 encoded.
	// Before you can use the contents of the field, you must decode and decompress
	// the contents. See the example for a simple function to decode and decompress
	// the contents.
	Interpretations *string `location:"header" locationName:"x-amz-lex-interpretations" min:"1" type:"string"`

	// A list of messages that were last sent to the user. The messages are ordered
	// based on the order that you returned the messages from your Lambda function
	// or the order that the messages are defined in the bot.
	//
	// The messages field is compressed with gzip and then base64 encoded. Before
	// you can use the contents of the field, you must decode and decompress the
	// contents. See the example for a simple function to decode and decompress
	// the contents.
	Messages *string `location:"header" locationName:"x-amz-lex-messages" min:"1" type:"string"`

	// The bot member that recognized the utterance.
	RecognizedBotMember *string `location:"header" locationName:"x-amz-lex-recognized-bot-member" min:"1" type:"string"`

	// The attributes sent in the request.
	//
	// The requestAttributes field is compressed with gzip and then base64 encoded.
	// Before you can use the contents of the field, you must decode and decompress
	// the contents.
	RequestAttributes *string `location:"header" locationName:"x-amz-lex-request-attributes" min:"1" type:"string"`

	// The identifier of the session in use.
	SessionId *string `location:"header" locationName:"x-amz-lex-session-id" min:"2" type:"string"`

	// Represents the current state of the dialog between the user and the bot.
	//
	// Use this to determine the progress of the conversation and what the next
	// action might be.
	//
	// The sessionState field is compressed with gzip and then base64 encoded. Before
	// you can use the contents of the field, you must decode and decompress the
	// contents. See the example for a simple function to decode and decompress
	// the contents.
	SessionState *string `location:"header" locationName:"x-amz-lex-session-state" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (RecognizeUtteranceOutput) GoString 

func (s RecognizeUtteranceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecognizeUtteranceOutput) SetAudioStream 

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

SetAudioStream sets the AudioStream field's value.

func (*RecognizeUtteranceOutput) SetContentType 

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

SetContentType sets the ContentType field's value.

func (*RecognizeUtteranceOutput) SetInputMode 

func (s *RecognizeUtteranceOutput) SetInputMode(v string) *RecognizeUtteranceOutput

SetInputMode sets the InputMode field's value.

func (*RecognizeUtteranceOutput) SetInputTranscript 

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

SetInputTranscript sets the InputTranscript field's value.

func (*RecognizeUtteranceOutput) SetInterpretations 

func (s *RecognizeUtteranceOutput) SetInterpretations(v string) *RecognizeUtteranceOutput

SetInterpretations sets the Interpretations field's value.

func (*RecognizeUtteranceOutput) SetMessages 

func (s *RecognizeUtteranceOutput) SetMessages(v string) *RecognizeUtteranceOutput

SetMessages sets the Messages field's value.

func (*RecognizeUtteranceOutput) SetRecognizedBotMember added in v1.42.9 

func (s *RecognizeUtteranceOutput) SetRecognizedBotMember(v string) *RecognizeUtteranceOutput

SetRecognizedBotMember sets the RecognizedBotMember field's value.

func (*RecognizeUtteranceOutput) SetRequestAttributes 

func (s *RecognizeUtteranceOutput) SetRequestAttributes(v string) *RecognizeUtteranceOutput

SetRequestAttributes sets the RequestAttributes field's value.

func (*RecognizeUtteranceOutput) SetSessionId 

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

SetSessionId sets the SessionId field's value.

func (*RecognizeUtteranceOutput) SetSessionState 

func (s *RecognizeUtteranceOutput) SetSessionState(v string) *RecognizeUtteranceOutput

SetSessionState sets the SessionState field's value.

func (RecognizeUtteranceOutput) String 

func (s RecognizeUtteranceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecognizedBotMember added in v1.42.9 

type RecognizedBotMember struct {

	// The identifier of the bot member that processes the request.
	//
	// BotId is a required field
	BotId *string `locationName:"botId" min:"10" type:"string" required:"true"`

	// The name of the bot member that processes the request.
	BotName *string `locationName:"botName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The bot member that processes the request.

func (RecognizedBotMember) GoString added in v1.42.9 

func (s RecognizedBotMember) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecognizedBotMember) SetBotId added in v1.42.9 

func (s *RecognizedBotMember) SetBotId(v string) *RecognizedBotMember

SetBotId sets the BotId field's value.

func (*RecognizedBotMember) SetBotName added in v1.42.9 

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

SetBotName sets the BotName field's value.

func (RecognizedBotMember) String added in v1.42.9 

func (s RecognizedBotMember) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

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

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

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) MarshalEvent 

func (s *ResourceNotFoundException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) UnmarshalEvent 

func (s *ResourceNotFoundException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ResourceNotFoundException value. This method is only used internally within the SDK's EventStream handling.

type RuntimeHintDetails added in v1.42.9 

type RuntimeHintDetails struct {

	// One or more strings that Amazon Lex V2 should look for in the input to the
	// bot. Each phrase is given preference when deciding on slot values.
	RuntimeHintValues []*RuntimeHintValue `locationName:"runtimeHintValues" min:"1" type:"list"`

	// A map of constituent sub slot names inside a composite slot in the intent
	// and the phrases that should be added for each sub slot. Inside each composite
	// slot hints, this structure provides a mechanism to add granular sub slot
	// phrases. Only sub slot hints are supported for composite slots. The intent
	// name, composite slot name and the constituent sub slot names must exist.
	SubSlotHints map[string]*RuntimeHintDetails `locationName:"subSlotHints" type:"map"`
	// contains filtered or unexported fields
}

Provides an array of phrases that should be given preference when resolving values for a slot.

func (RuntimeHintDetails) GoString added in v1.42.9 

func (s RuntimeHintDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuntimeHintDetails) SetRuntimeHintValues added in v1.42.9 

func (s *RuntimeHintDetails) SetRuntimeHintValues(v []*RuntimeHintValue) *RuntimeHintDetails

SetRuntimeHintValues sets the RuntimeHintValues field's value.

func (*RuntimeHintDetails) SetSubSlotHints added in v1.42.9 

func (s *RuntimeHintDetails) SetSubSlotHints(v map[string]*RuntimeHintDetails) *RuntimeHintDetails

SetSubSlotHints sets the SubSlotHints field's value.

func (RuntimeHintDetails) String added in v1.42.9 

func (s RuntimeHintDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuntimeHintValue added in v1.42.9 

type RuntimeHintValue struct {

	// The phrase that Amazon Lex V2 should look for in the user's input to the
	// bot.
	//
	// Phrase is a required field
	Phrase *string `locationName:"phrase" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the phrase that Amazon Lex V2 should look for in the user's input to the bot.

func (RuntimeHintValue) GoString added in v1.42.9 

func (s RuntimeHintValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuntimeHintValue) SetPhrase added in v1.42.9 

func (s *RuntimeHintValue) SetPhrase(v string) *RuntimeHintValue

SetPhrase sets the Phrase field's value.

func (RuntimeHintValue) String added in v1.42.9 

func (s RuntimeHintValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuntimeHints added in v1.42.9 

type RuntimeHints struct {

	// A list of the slots in the intent that should have runtime hints added, and
	// the phrases that should be added for each slot.
	//
	// The first level of the slotHints map is the name of the intent. The second
	// level is the name of the slot within the intent. For more information, see
	// Using hints to improve accuracy (https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html).
	//
	// The intent name and slot name must exist.
	SlotHints map[string]map[string]*RuntimeHintDetails `locationName:"slotHints" type:"map"`
	// contains filtered or unexported fields
}

You can provide Amazon Lex V2 with hints to the phrases that a customer is likely to use for a slot. When a slot with hints is resolved, the phrases in the runtime hints are preferred in the resolution. You can provide hints for a maximum of 100 intents. You can provide a maximum of 100 slots.

Before you can use runtime hints with an existing bot, you must first rebuild the bot.

For more information, see Using runtime hints to improve recognition of slot values (https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html).

func (RuntimeHints) GoString added in v1.42.9 

func (s RuntimeHints) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuntimeHints) SetSlotHints added in v1.42.9 

func (s *RuntimeHints) SetSlotHints(v map[string]map[string]*RuntimeHintDetails) *RuntimeHints

SetSlotHints sets the SlotHints field's value.

func (RuntimeHints) String added in v1.42.9 

func (s RuntimeHints) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SentimentResponse 

type SentimentResponse struct {

	// The overall sentiment expressed in the user's response. This is the sentiment
	// most likely expressed by the user based on the analysis by Amazon Comprehend.
	Sentiment *string `locationName:"sentiment" type:"string" enum:"SentimentType"`

	// The individual sentiment responses for the utterance.
	SentimentScore *SentimentScore `locationName:"sentimentScore" type:"structure"`
	// contains filtered or unexported fields
}

Provides information about the sentiment expressed in a user's response in a conversation. Sentiments are determined using Amazon Comprehend. Sentiments are only returned if they are enabled for the bot.

For more information, see Determine Sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html) in the Amazon Comprehend developer guide.

func (SentimentResponse) GoString 

func (s SentimentResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SentimentResponse) SetSentiment 

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

SetSentiment sets the Sentiment field's value.

func (*SentimentResponse) SetSentimentScore 

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

SetSentimentScore sets the SentimentScore field's value.

func (SentimentResponse) String 

func (s SentimentResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SentimentScore 

type SentimentScore struct {

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the MIXED sentiment.
	Mixed *float64 `locationName:"mixed" type:"double"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the NEGATIVE sentiment.
	Negative *float64 `locationName:"negative" type:"double"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the NEUTRAL sentiment.
	Neutral *float64 `locationName:"neutral" type:"double"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the POSITIVE sentiment.
	Positive *float64 `locationName:"positive" type:"double"`
	// contains filtered or unexported fields
}

The individual sentiment responses for the utterance.

func (SentimentScore) GoString 

func (s SentimentScore) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SentimentScore) SetMixed 

func (s *SentimentScore) SetMixed(v float64) *SentimentScore

SetMixed sets the Mixed field's value.

func (*SentimentScore) SetNegative 

func (s *SentimentScore) SetNegative(v float64) *SentimentScore

SetNegative sets the Negative field's value.

func (*SentimentScore) SetNeutral 

func (s *SentimentScore) SetNeutral(v float64) *SentimentScore

SetNeutral sets the Neutral field's value.

func (*SentimentScore) SetPositive 

func (s *SentimentScore) SetPositive(v float64) *SentimentScore

SetPositive sets the Positive field's value.

func (SentimentScore) String 

func (s SentimentScore) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SessionState 

type SessionState struct {

	// One or more contexts that indicate to Amazon Lex V2 the context of a request.
	// When a context is active, Amazon Lex V2 considers intents with the matching
	// context as a trigger as the next intent in a session.
	ActiveContexts []*ActiveContext `locationName:"activeContexts" type:"list"`

	// The next step that Amazon Lex V2 should take in the conversation with a user.
	DialogAction *DialogAction `locationName:"dialogAction" type:"structure"`

	// The active intent that Amazon Lex V2 is processing.
	Intent *Intent `locationName:"intent" type:"structure"`

	// A unique identifier for a specific request.
	OriginatingRequestId *string `locationName:"originatingRequestId" min:"1" type:"string"`

	// Hints for phrases that a customer is likely to use for a slot. Amazon Lex
	// V2 uses the hints to help determine the correct value of a slot.
	RuntimeHints *RuntimeHints `locationName:"runtimeHints" type:"structure"`

	// Map of key/value pairs representing session-specific context information.
	// It contains application information passed between Amazon Lex V2 and a client
	// application.
	SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map"`
	// contains filtered or unexported fields
}

The state of the user's session with Amazon Lex V2.

func (SessionState) GoString 

func (s SessionState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionState) SetActiveContexts 

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

SetActiveContexts sets the ActiveContexts field's value.

func (*SessionState) SetDialogAction 

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

SetDialogAction sets the DialogAction field's value.

func (*SessionState) SetIntent 

func (s *SessionState) SetIntent(v *Intent) *SessionState

SetIntent sets the Intent field's value.

func (*SessionState) SetOriginatingRequestId 

func (s *SessionState) SetOriginatingRequestId(v string) *SessionState

SetOriginatingRequestId sets the OriginatingRequestId field's value.

func (*SessionState) SetRuntimeHints added in v1.42.9 

func (s *SessionState) SetRuntimeHints(v *RuntimeHints) *SessionState

SetRuntimeHints sets the RuntimeHints field's value.

func (*SessionState) SetSessionAttributes 

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

SetSessionAttributes sets the SessionAttributes field's value.

func (SessionState) String 

func (s SessionState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionState) Validate 

func (s *SessionState) Validate() error

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

type Slot 

type Slot struct {

	// When the shape value is List, it indicates that the values field contains
	// a list of slot values. When the value is Scalar, it indicates that the value
	// field contains a single value.
	Shape *string `locationName:"shape" type:"string" enum:"Shape"`

	// The constituent sub slots of a composite slot.
	SubSlots map[string]*Slot `locationName:"subSlots" type:"map"`

	// The current value of the slot.
	Value *Value `locationName:"value" type:"structure"`

	// A list of one or more values that the user provided for the slot. For example,
	// if a for a slot that elicits pizza toppings, the values might be "pepperoni"
	// and "pineapple."
	Values []*Slot `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

A value that Amazon Lex V2 uses to fulfill an intent.

func (Slot) GoString 

func (s Slot) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Slot) SetShape 

func (s *Slot) SetShape(v string) *Slot

SetShape sets the Shape field's value.

func (*Slot) SetSubSlots added in v1.42.9 

func (s *Slot) SetSubSlots(v map[string]*Slot) *Slot

SetSubSlots sets the SubSlots field's value.

func (*Slot) SetValue 

func (s *Slot) SetValue(v *Value) *Slot

SetValue sets the Value field's value.

func (*Slot) SetValues 

func (s *Slot) SetValues(v []*Slot) *Slot

SetValues sets the Values field's value.

func (Slot) String 

func (s Slot) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Slot) Validate 

func (s *Slot) Validate() error

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

type StartConversationEventStream 

type StartConversationEventStream struct {

	// Writer is the EventStream writer for the StartConversationRequestEventStream
	// events. This value is automatically set by the SDK when the API call is made
	// Use this member when unit testing your code with the SDK to mock out the
	// EventStream Writer.
	//
	// Must not be nil.
	Writer StartConversationRequestEventStreamWriter

	// Reader is the EventStream reader for the StartConversationResponseEventStream
	// events. This value is automatically set by the SDK when the API call is made
	// Use this member when unit testing your code with the SDK to mock out the
	// EventStream Reader.
	//
	// Must not be nil.
	Reader StartConversationResponseEventStreamReader
	// contains filtered or unexported fields
}

StartConversationEventStream provides the event stream handling for the StartConversation.

For testing and mocking the event stream this type should be initialized via the NewStartConversationEventStream constructor function. Using the functional options to pass in nested mock behavior.

func NewStartConversationEventStream 

func NewStartConversationEventStream(opts ...func(*StartConversationEventStream)) *StartConversationEventStream

NewStartConversationEventStream initializes an StartConversationEventStream. This function should only be used for testing and mocking the StartConversationEventStream stream within your application.

The Writer member must be set before writing events to the stream.

The Reader member must be set before reading events from the stream. 

es := NewStartConversationEventStream(func(o *StartConversationEventStream){
    es.Writer = myMockStreamWriter
    es.Reader = myMockStreamReader
})

func (*StartConversationEventStream) Close 

func (es *StartConversationEventStream) Close() (err error)

Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.

Will close the underlying EventStream writer, and no more events can be sent.

You can use the closing of the Reader's Events channel to terminate your application's read from the API's stream.

func (*StartConversationEventStream) Err 

func (es *StartConversationEventStream) Err() error

Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.

func (*StartConversationEventStream) Events 

func (es *StartConversationEventStream) Events() <-chan StartConversationResponseEventStreamEvent

Events returns a channel to read events from.

These events are:

  • AudioResponseEvent
  • HeartbeatEvent
  • IntentResultEvent
  • PlaybackInterruptionEvent
  • TextResponseEvent
  • TranscriptEvent
  • StartConversationResponseEventStreamUnknownEvent

func (*StartConversationEventStream) Send 

func (es *StartConversationEventStream) Send(ctx aws.Context, event StartConversationRequestEventStreamEvent) error

Send writes the event to the stream blocking until the event is written. Returns an error if the event was not written.

These events are:

  • AudioInputEvent
  • ConfigurationEvent
  • DTMFInputEvent
  • DisconnectionEvent
  • PlaybackCompletionEvent
  • TextInputEvent

type StartConversationInput 

type StartConversationInput struct {

	// The alias identifier in use for the bot that processes the request.
	//
	// BotAliasId is a required field
	BotAliasId *string `location:"uri" locationName:"botAliasId" type:"string" required:"true"`

	// The identifier of the bot to process the request.
	//
	// BotId is a required field
	BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"`

	// The conversation type that you are using the Amazon Lex V2. If the conversation
	// mode is AUDIO you can send both audio and DTMF information. If the mode is
	// TEXT you can only send text.
	ConversationMode *string `location:"header" locationName:"x-amz-lex-conversation-mode" type:"string" enum:"ConversationMode"`

	// The locale where the session is in use.
	//
	// LocaleId is a required field
	LocaleId *string `location:"uri" locationName:"localeId" min:"1" type:"string" required:"true"`

	// The identifier of the user session that is having the conversation.
	//
	// SessionId is a required field
	SessionId *string `location:"uri" locationName:"sessionId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartConversationInput) GoString 

func (s StartConversationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartConversationInput) SetBotAliasId 

func (s *StartConversationInput) SetBotAliasId(v string) *StartConversationInput

SetBotAliasId sets the BotAliasId field's value.

func (*StartConversationInput) SetBotId 

func (s *StartConversationInput) SetBotId(v string) *StartConversationInput

SetBotId sets the BotId field's value.

func (*StartConversationInput) SetConversationMode 

func (s *StartConversationInput) SetConversationMode(v string) *StartConversationInput

SetConversationMode sets the ConversationMode field's value.

func (*StartConversationInput) SetLocaleId 

func (s *StartConversationInput) SetLocaleId(v string) *StartConversationInput

SetLocaleId sets the LocaleId field's value.

func (*StartConversationInput) SetSessionId 

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

SetSessionId sets the SessionId field's value.

func (StartConversationInput) String 

func (s StartConversationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartConversationInput) Validate 

func (s *StartConversationInput) Validate() error

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

type StartConversationOutput 

type StartConversationOutput struct {
	// contains filtered or unexported fields
}

func (*StartConversationOutput) GetStream 

func (s *StartConversationOutput) GetStream() *StartConversationEventStream

GetStream returns the type to interact with the event stream.

func (StartConversationOutput) GoString 

func (s StartConversationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StartConversationOutput) String 

func (s StartConversationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartConversationRequestEventStreamEvent 

type StartConversationRequestEventStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

StartConversationRequestEventStreamEvent groups together all EventStream events writes for StartConversationRequestEventStream.

These events are:

  • AudioInputEvent
  • ConfigurationEvent
  • DTMFInputEvent
  • DisconnectionEvent
  • PlaybackCompletionEvent
  • TextInputEvent

type StartConversationRequestEventStreamWriter 

type StartConversationRequestEventStreamWriter interface {
	// Sends writes events to the stream blocking until the event has been
	// written. An error is returned if the write fails.
	Send(aws.Context, StartConversationRequestEventStreamEvent) error

	// Close will stop the writer writing to the event stream.
	Close() error

	// Returns any error that has occurred while writing to the event stream.
	Err() error
}

StartConversationRequestEventStreamWriter provides the interface for writing events to the stream. The default implementation for this interface will be StartConversationRequestEventStream.

The writer's Close method must allow multiple concurrent calls.

These events are:

  • AudioInputEvent
  • ConfigurationEvent
  • DTMFInputEvent
  • DisconnectionEvent
  • PlaybackCompletionEvent
  • TextInputEvent

type StartConversationResponseEventStreamEvent 

type StartConversationResponseEventStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

StartConversationResponseEventStreamEvent groups together all EventStream events writes for StartConversationResponseEventStream.

These events are:

  • AudioResponseEvent
  • HeartbeatEvent
  • IntentResultEvent
  • PlaybackInterruptionEvent
  • TextResponseEvent
  • TranscriptEvent

type StartConversationResponseEventStreamReader 

type StartConversationResponseEventStreamReader interface {
	// Returns a channel of events as they are read from the event stream.
	Events() <-chan StartConversationResponseEventStreamEvent

	// Close will stop the reader reading events from the stream.
	Close() error

	// Returns any error that has occurred while reading from the event stream.
	Err() error
}

StartConversationResponseEventStreamReader provides the interface for reading to the stream. The default implementation for this interface will be StartConversationResponseEventStream.

The reader's Close method must allow multiple concurrent calls.

These events are:

  • AudioResponseEvent
  • HeartbeatEvent
  • IntentResultEvent
  • PlaybackInterruptionEvent
  • TextResponseEvent
  • TranscriptEvent
  • StartConversationResponseEventStreamUnknownEvent

type StartConversationResponseEventStreamUnknownEvent 

type StartConversationResponseEventStreamUnknownEvent struct {
	Type    string
	Message eventstream.Message
}

StartConversationResponseEventStreamUnknownEvent provides a failsafe event for the StartConversationResponseEventStream group of events when an unknown event is received.

func (*StartConversationResponseEventStreamUnknownEvent) MarshalEvent 

func (e *StartConversationResponseEventStreamUnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) (
	msg eventstream.Message, err error,
)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*StartConversationResponseEventStreamUnknownEvent) UnmarshalEvent 

func (e *StartConversationResponseEventStreamUnknownEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the StartConversationResponseEventStream value. This method is only used internally within the SDK's EventStream handling.

type TextInputEvent 

type TextInputEvent struct {

	// A timestamp set by the client of the date and time that the event was sent
	// to Amazon Lex V2.
	ClientTimestampMillis *int64 `locationName:"clientTimestampMillis" type:"long"`

	// A unique identifier that your application assigns to the event. You can use
	// this to identify events in logs.
	EventId *string `locationName:"eventId" min:"2" type:"string"`

	// The text from the user. Amazon Lex V2 processes this as a complete statement.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TextInputEvent's
	// String and GoString methods.
	//
	// Text is a required field
	Text *string `locationName:"text" min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

The event sent from your client application to Amazon Lex V2 with text input from the user.

func (TextInputEvent) GoString 

func (s TextInputEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TextInputEvent) MarshalEvent 

func (s *TextInputEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*TextInputEvent) SetClientTimestampMillis 

func (s *TextInputEvent) SetClientTimestampMillis(v int64) *TextInputEvent

SetClientTimestampMillis sets the ClientTimestampMillis field's value.

func (*TextInputEvent) SetEventId 

func (s *TextInputEvent) SetEventId(v string) *TextInputEvent

SetEventId sets the EventId field's value.

func (*TextInputEvent) SetText 

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

SetText sets the Text field's value.

func (TextInputEvent) String 

func (s TextInputEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TextInputEvent) UnmarshalEvent 

func (s *TextInputEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the TextInputEvent value. This method is only used internally within the SDK's EventStream handling.

type TextResponseEvent 

type TextResponseEvent struct {

	// A unique identifier of the event sent by Amazon Lex V2. The identifier is
	// in the form RESPONSE-N, where N is a number starting with one and incremented
	// for each event sent by Amazon Lex V2 in the current session.
	EventId *string `locationName:"eventId" min:"2" type:"string"`

	// A list of messages to send to the user. Messages are ordered based on the
	// order that you returned the messages from your Lambda function or the order
	// that the messages are defined in the bot.
	Messages []*Message `locationName:"messages" type:"list"`
	// contains filtered or unexported fields
}

The event sent from Amazon Lex V2 to your application with text to present to the user.

func (TextResponseEvent) GoString 

func (s TextResponseEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TextResponseEvent) MarshalEvent 

func (s *TextResponseEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*TextResponseEvent) SetEventId 

func (s *TextResponseEvent) SetEventId(v string) *TextResponseEvent

SetEventId sets the EventId field's value.

func (*TextResponseEvent) SetMessages 

func (s *TextResponseEvent) SetMessages(v []*Message) *TextResponseEvent

SetMessages sets the Messages field's value.

func (TextResponseEvent) String 

func (s TextResponseEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TextResponseEvent) UnmarshalEvent 

func (s *TextResponseEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the TextResponseEvent value. This method is only used internally within the SDK's EventStream handling.

type ThrottlingException 

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

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

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) MarshalEvent 

func (s *ThrottlingException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) UnmarshalEvent 

func (s *ThrottlingException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ThrottlingException value. This method is only used internally within the SDK's EventStream handling.

type TranscriptEvent 

type TranscriptEvent struct {

	// A unique identifier of the event sent by Amazon Lex V2. The identifier is
	// in the form RESPONSE-N, where N is a number starting with one and incremented
	// for each event sent by Amazon Lex V2 in the current session.
	EventId *string `locationName:"eventId" min:"2" type:"string"`

	// The transcript of the voice audio from the user.
	Transcript *string `locationName:"transcript" type:"string"`
	// contains filtered or unexported fields
}

Event sent from Amazon Lex V2 to your client application that contains a transcript of voice audio.

func (TranscriptEvent) GoString 

func (s TranscriptEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TranscriptEvent) MarshalEvent 

func (s *TranscriptEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*TranscriptEvent) SetEventId 

func (s *TranscriptEvent) SetEventId(v string) *TranscriptEvent

SetEventId sets the EventId field's value.

func (*TranscriptEvent) SetTranscript 

func (s *TranscriptEvent) SetTranscript(v string) *TranscriptEvent

SetTranscript sets the Transcript field's value.

func (TranscriptEvent) String 

func (s TranscriptEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TranscriptEvent) UnmarshalEvent 

func (s *TranscriptEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the TranscriptEvent value. This method is only used internally within the SDK's EventStream handling.

type ValidationException 

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

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

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) MarshalEvent 

func (s *ValidationException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) UnmarshalEvent 

func (s *ValidationException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ValidationException value. This method is only used internally within the SDK's EventStream handling.

type Value 

type Value struct {

	// The value that Amazon Lex V2 determines for the slot. The actual value depends
	// on the setting of the value selection strategy for the bot. You can choose
	// to use the value entered by the user, or you can have Amazon Lex V2 choose
	// the first value in the resolvedValues list.
	//
	// InterpretedValue is a required field
	InterpretedValue *string `locationName:"interpretedValue" min:"1" type:"string" required:"true"`

	// The text of the utterance from the user that was entered for the slot.
	OriginalValue *string `locationName:"originalValue" min:"1" type:"string"`

	// A list of additional values that have been recognized for the slot.
	ResolvedValues []*string `locationName:"resolvedValues" type:"list"`
	// contains filtered or unexported fields
}

The value of a slot.

func (Value) GoString 

func (s Value) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Value) SetInterpretedValue 

func (s *Value) SetInterpretedValue(v string) *Value

SetInterpretedValue sets the InterpretedValue field's value.

func (*Value) SetOriginalValue 

func (s *Value) SetOriginalValue(v string) *Value

SetOriginalValue sets the OriginalValue field's value.

func (*Value) SetResolvedValues 

func (s *Value) SetResolvedValues(v []*string) *Value

SetResolvedValues sets the ResolvedValues field's value.

func (Value) String 

func (s Value) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Value) Validate 

func (s *Value) Validate() error

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

Source Files

View all Source files

Directories

Path Synopsis
Package lexruntimev2iface provides an interface to enable mocking the Amazon Lex Runtime V2 service client for testing your code.
 Package lexruntimev2iface provides an interface to enable mocking the Amazon Lex Runtime V2 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.