...

Package interactionmodel

import "google.golang.org/genproto/googleapis/actions/sdk/v2/interactionmodel"
Overview
Index
Subdirectories

Overview ▾

Index ▾

Variables
type ConditionalEvent
    func (*ConditionalEvent) Descriptor() ([]byte, []int)
    func (x *ConditionalEvent) GetCondition() string
    func (x *ConditionalEvent) GetHandler() *EventHandler
    func (x *ConditionalEvent) GetTransitionToScene() string
    func (*ConditionalEvent) ProtoMessage()
    func (x *ConditionalEvent) ProtoReflect() protoreflect.Message
    func (x *ConditionalEvent) Reset()
    func (x *ConditionalEvent) String() string
type EntitySet
    func (*EntitySet) Descriptor() ([]byte, []int)
    func (x *EntitySet) GetEntities() []*EntitySet_Entity
    func (*EntitySet) ProtoMessage()
    func (x *EntitySet) ProtoReflect() protoreflect.Message
    func (x *EntitySet) Reset()
    func (x *EntitySet) String() string
type EntitySet_Entity
    func (*EntitySet_Entity) Descriptor() ([]byte, []int)
    func (x *EntitySet_Entity) GetId() string
    func (*EntitySet_Entity) ProtoMessage()
    func (x *EntitySet_Entity) ProtoReflect() protoreflect.Message
    func (x *EntitySet_Entity) Reset()
    func (x *EntitySet_Entity) String() string
type EventHandler
    func (*EventHandler) Descriptor() ([]byte, []int)
    func (m *EventHandler) GetPrompt() isEventHandler_Prompt
    func (x *EventHandler) GetStaticPrompt() *prompt.StaticPrompt
    func (x *EventHandler) GetStaticPromptName() string
    func (x *EventHandler) GetWebhookHandler() string
    func (*EventHandler) ProtoMessage()
    func (x *EventHandler) ProtoReflect() protoreflect.Message
    func (x *EventHandler) Reset()
    func (x *EventHandler) String() string
type EventHandler_StaticPrompt
type EventHandler_StaticPromptName
type GlobalIntentEvent
    func (*GlobalIntentEvent) Descriptor() ([]byte, []int)
    func (x *GlobalIntentEvent) GetHandler() *EventHandler
    func (x *GlobalIntentEvent) GetTransitionToScene() string
    func (*GlobalIntentEvent) ProtoMessage()
    func (x *GlobalIntentEvent) ProtoReflect() protoreflect.Message
    func (x *GlobalIntentEvent) Reset()
    func (x *GlobalIntentEvent) String() string
type Intent
    func (*Intent) Descriptor() ([]byte, []int)
    func (x *Intent) GetParameters() []*Intent_IntentParameter
    func (x *Intent) GetTrainingPhrases() []string
    func (*Intent) ProtoMessage()
    func (x *Intent) ProtoReflect() protoreflect.Message
    func (x *Intent) Reset()
    func (x *Intent) String() string
type IntentEvent
    func (*IntentEvent) Descriptor() ([]byte, []int)
    func (x *IntentEvent) GetHandler() *EventHandler
    func (x *IntentEvent) GetIntent() string
    func (x *IntentEvent) GetTransitionToScene() string
    func (*IntentEvent) ProtoMessage()
    func (x *IntentEvent) ProtoReflect() protoreflect.Message
    func (x *IntentEvent) Reset()
    func (x *IntentEvent) String() string
type Intent_IntentParameter
    func (*Intent_IntentParameter) Descriptor() ([]byte, []int)
    func (x *Intent_IntentParameter) GetEntitySetReferences() *Intent_IntentParameter_EntitySetReferences
    func (x *Intent_IntentParameter) GetName() string
    func (m *Intent_IntentParameter) GetParameterType() isIntent_IntentParameter_ParameterType
    func (x *Intent_IntentParameter) GetType() *_type.ClassReference
    func (*Intent_IntentParameter) ProtoMessage()
    func (x *Intent_IntentParameter) ProtoReflect() protoreflect.Message
    func (x *Intent_IntentParameter) Reset()
    func (x *Intent_IntentParameter) String() string
type Intent_IntentParameter_EntitySetReferences
    func (*Intent_IntentParameter_EntitySetReferences) Descriptor() ([]byte, []int)
    func (x *Intent_IntentParameter_EntitySetReferences) GetEntitySetReferences() []*Intent_IntentParameter_EntitySetReferences_EntitySetReference
    func (*Intent_IntentParameter_EntitySetReferences) ProtoMessage()
    func (x *Intent_IntentParameter_EntitySetReferences) ProtoReflect() protoreflect.Message
    func (x *Intent_IntentParameter_EntitySetReferences) Reset()
    func (x *Intent_IntentParameter_EntitySetReferences) String() string
type Intent_IntentParameter_EntitySetReferences_
type Intent_IntentParameter_EntitySetReferences_EntitySetReference
    func (*Intent_IntentParameter_EntitySetReferences_EntitySetReference) Descriptor() ([]byte, []int)
    func (x *Intent_IntentParameter_EntitySetReferences_EntitySetReference) GetEntitySet() string
    func (*Intent_IntentParameter_EntitySetReferences_EntitySetReference) ProtoMessage()
    func (x *Intent_IntentParameter_EntitySetReferences_EntitySetReference) ProtoReflect() protoreflect.Message
    func (x *Intent_IntentParameter_EntitySetReferences_EntitySetReference) Reset()
    func (x *Intent_IntentParameter_EntitySetReferences_EntitySetReference) String() string
type Intent_IntentParameter_Type
type Scene
    func (*Scene) Descriptor() ([]byte, []int)
    func (x *Scene) GetConditionalEvents() []*ConditionalEvent
    func (x *Scene) GetIntentEvents() []*IntentEvent
    func (x *Scene) GetOnEnter() *EventHandler
    func (x *Scene) GetOnSlotUpdated() *EventHandler
    func (x *Scene) GetSlots() []*Slot
    func (*Scene) ProtoMessage()
    func (x *Scene) ProtoReflect() protoreflect.Message
    func (x *Scene) Reset()
    func (x *Scene) String() string
type Slot
    func (*Slot) Descriptor() ([]byte, []int)
    func (x *Slot) GetCommitBehavior() *Slot_CommitBehavior
    func (x *Slot) GetConfig() *structpb.Value
    func (x *Slot) GetDefaultValue() *Slot_DefaultValue
    func (x *Slot) GetName() string
    func (x *Slot) GetPromptSettings() *Slot_PromptSettings
    func (x *Slot) GetRequired() bool
    func (x *Slot) GetType() *_type.ClassReference
    func (*Slot) ProtoMessage()
    func (x *Slot) ProtoReflect() protoreflect.Message
    func (x *Slot) Reset()
    func (x *Slot) String() string
type Slot_CommitBehavior
    func (*Slot_CommitBehavior) Descriptor() ([]byte, []int)
    func (x *Slot_CommitBehavior) GetWriteSessionParam() string
    func (*Slot_CommitBehavior) ProtoMessage()
    func (x *Slot_CommitBehavior) ProtoReflect() protoreflect.Message
    func (x *Slot_CommitBehavior) Reset()
    func (x *Slot_CommitBehavior) String() string
type Slot_DefaultValue
    func (*Slot_DefaultValue) Descriptor() ([]byte, []int)
    func (x *Slot_DefaultValue) GetConstant() *structpb.Value
    func (x *Slot_DefaultValue) GetSessionParam() string
    func (*Slot_DefaultValue) ProtoMessage()
    func (x *Slot_DefaultValue) ProtoReflect() protoreflect.Message
    func (x *Slot_DefaultValue) Reset()
    func (x *Slot_DefaultValue) String() string
type Slot_PromptSettings
    func (*Slot_PromptSettings) Descriptor() ([]byte, []int)
    func (x *Slot_PromptSettings) GetInitialPrompt() *EventHandler
    func (x *Slot_PromptSettings) GetNoInputFinalPrompt() *EventHandler
    func (x *Slot_PromptSettings) GetNoInputPrompt1() *EventHandler
    func (x *Slot_PromptSettings) GetNoInputPrompt2() *EventHandler
    func (x *Slot_PromptSettings) GetNoMatchFinalPrompt() *EventHandler
    func (x *Slot_PromptSettings) GetNoMatchPrompt1() *EventHandler
    func (x *Slot_PromptSettings) GetNoMatchPrompt2() *EventHandler
    func (*Slot_PromptSettings) ProtoMessage()
    func (x *Slot_PromptSettings) ProtoReflect() protoreflect.Message
    func (x *Slot_PromptSettings) Reset()
    func (x *Slot_PromptSettings) String() string

Package files

conditional_event.pb.go entity_set.pb.go event_handler.pb.go global_intent_event.pb.go intent.pb.go intent_event.pb.go scene.pb.go slot.pb.go

Variables

var File_google_actions_sdk_v2_interactionmodel_conditional_event_proto protoreflect.FileDescriptor
var File_google_actions_sdk_v2_interactionmodel_entity_set_proto protoreflect.FileDescriptor
var File_google_actions_sdk_v2_interactionmodel_event_handler_proto protoreflect.FileDescriptor
var File_google_actions_sdk_v2_interactionmodel_global_intent_event_proto protoreflect.FileDescriptor
var File_google_actions_sdk_v2_interactionmodel_intent_event_proto protoreflect.FileDescriptor
var File_google_actions_sdk_v2_interactionmodel_intent_proto protoreflect.FileDescriptor
var File_google_actions_sdk_v2_interactionmodel_scene_proto protoreflect.FileDescriptor
var File_google_actions_sdk_v2_interactionmodel_slot_proto protoreflect.FileDescriptor

type ConditionalEvent

Registers events that trigger as the result of a true condition.

type ConditionalEvent struct {

    // Required. Filter condition for this event to trigger. If condition is evaluated to
    // true then the associated `handler` will be triggered.
    // The following variable references are supported:
    //
    //	`$session` - To reference data in session storage.
    //	`$user` - To reference data in user storage.
    //
    // The following boolean operators are supported (with examples):
    //
    //	`&&` - `session.params.counter > 0 && session.params.counter < 100`
    //	`||` - `session.params.foo == "John" || session.params.counter == "Adam"`
    //	`!`  - `!(session.params.counter == 5)`
    //
    // The following comparisons are supported:
    //
    //	`==`, `!=`, `<`, `>`, `<=`, `>=`
    //
    // The following list and string operators are supported (with examples):
    //
    //	`in`        - "Watermelon" in `session.params.fruitList`
    //	`size`      - `size(session.params.fruitList) > 2`
    //	`substring` - `session.params.fullName.contains("John")`
    Condition string `protobuf:"bytes,1,opt,name=condition,proto3" json:"condition,omitempty"`
    // Optional. Destination scene which the conversation should jump to when the associated
    // condition is evaluated to true. The state of the current scene is destroyed
    // on the transition.
    TransitionToScene string `protobuf:"bytes,2,opt,name=transition_to_scene,json=transitionToScene,proto3" json:"transition_to_scene,omitempty"`
    // Optional. Event handler which is triggered when the associated condition is evaluated
    // to `true`. Should execute before transitioning to the destination scene.
    // Useful to generate Prompts in response to events.
    Handler *EventHandler `protobuf:"bytes,3,opt,name=handler,proto3" json:"handler,omitempty"`
    // contains filtered or unexported fields
}

func (*ConditionalEvent) Descriptor

func (*ConditionalEvent) Descriptor() ([]byte, []int)

Deprecated: Use ConditionalEvent.ProtoReflect.Descriptor instead.

func (*ConditionalEvent) GetCondition

func (x *ConditionalEvent) GetCondition() string

func (*ConditionalEvent) GetHandler

func (x *ConditionalEvent) GetHandler() *EventHandler

func (*ConditionalEvent) GetTransitionToScene

func (x *ConditionalEvent) GetTransitionToScene() string

func (*ConditionalEvent) ProtoMessage

func (*ConditionalEvent) ProtoMessage()

func (*ConditionalEvent) ProtoReflect

func (x *ConditionalEvent) ProtoReflect() protoreflect.Message

func (*ConditionalEvent) Reset

func (x *ConditionalEvent) Reset()

func (*ConditionalEvent) String

func (x *ConditionalEvent) String() string

type EntitySet

Entity sets describe the pre-defined set of entities that the values of built-in intent parameters can come from. Entity sets can be referenced from entity_set in built-in intent parameters.

type EntitySet struct {

    // Required. The list of entities this entity set supports.
    Entities []*EntitySet_Entity `protobuf:"bytes,1,rep,name=entities,proto3" json:"entities,omitempty"`
    // contains filtered or unexported fields
}

func (*EntitySet) Descriptor

func (*EntitySet) Descriptor() ([]byte, []int)

Deprecated: Use EntitySet.ProtoReflect.Descriptor instead.

func (*EntitySet) GetEntities

func (x *EntitySet) GetEntities() []*EntitySet_Entity

func (*EntitySet) ProtoMessage

func (*EntitySet) ProtoMessage()

func (*EntitySet) ProtoReflect

func (x *EntitySet) ProtoReflect() protoreflect.Message

func (*EntitySet) Reset

func (x *EntitySet) Reset()

func (*EntitySet) String

func (x *EntitySet) String() string

type EntitySet_Entity

An entity a built-in intent parameter value can come from.

type EntitySet_Entity struct {

    // Required. The ID of the entity.
    // For a list of built-in-intent parameters and their supported entities,
    // see
    // https://developers.google.com/assistant/conversational/build/built-in-intents
    Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
    // contains filtered or unexported fields
}

func (*EntitySet_Entity) Descriptor

func (*EntitySet_Entity) Descriptor() ([]byte, []int)

Deprecated: Use EntitySet_Entity.ProtoReflect.Descriptor instead.

func (*EntitySet_Entity) GetId

func (x *EntitySet_Entity) GetId() string

func (*EntitySet_Entity) ProtoMessage

func (*EntitySet_Entity) ProtoMessage()

func (*EntitySet_Entity) ProtoReflect

func (x *EntitySet_Entity) ProtoReflect() protoreflect.Message

func (*EntitySet_Entity) Reset

func (x *EntitySet_Entity) Reset()

func (*EntitySet_Entity) String

func (x *EntitySet_Entity) String() string

type EventHandler

Defines a handler to be executed after an event. Examples of events are intent and condition based events in a scene.

type EventHandler struct {

    // Name of the webhook handler to call.
    WebhookHandler string `protobuf:"bytes,1,opt,name=webhook_handler,json=webhookHandler,proto3" json:"webhook_handler,omitempty"`
    // Prompts can either be inlined or referenced by name.
    //
    // Types that are assignable to Prompt:
    //
    //	*EventHandler_StaticPrompt
    //	*EventHandler_StaticPromptName
    Prompt isEventHandler_Prompt `protobuf_oneof:"prompt"`
    // contains filtered or unexported fields
}

func (*EventHandler) Descriptor

func (*EventHandler) Descriptor() ([]byte, []int)

Deprecated: Use EventHandler.ProtoReflect.Descriptor instead.

func (*EventHandler) GetPrompt

func (m *EventHandler) GetPrompt() isEventHandler_Prompt

func (*EventHandler) GetStaticPrompt

func (x *EventHandler) GetStaticPrompt() *prompt.StaticPrompt

func (*EventHandler) GetStaticPromptName

func (x *EventHandler) GetStaticPromptName() string

func (*EventHandler) GetWebhookHandler

func (x *EventHandler) GetWebhookHandler() string

func (*EventHandler) ProtoMessage

func (*EventHandler) ProtoMessage()

func (*EventHandler) ProtoReflect

func (x *EventHandler) ProtoReflect() protoreflect.Message

func (*EventHandler) Reset

func (x *EventHandler) Reset()

func (*EventHandler) String

func (x *EventHandler) String() string

type EventHandler_StaticPrompt

type EventHandler_StaticPrompt struct {
    // Inlined static prompt. Can contain references to string resources in
    // bundles.
    StaticPrompt *prompt.StaticPrompt `protobuf:"bytes,2,opt,name=static_prompt,json=staticPrompt,proto3,oneof"`
}

type EventHandler_StaticPromptName

type EventHandler_StaticPromptName struct {
    // Name of the static prompt to invoke.
    StaticPromptName string `protobuf:"bytes,3,opt,name=static_prompt_name,json=staticPromptName,proto3,oneof"`
}

type GlobalIntentEvent

Defines a global intent handler. Global intent events are scoped to the entire Actions project and may be overridden by intent handlers in a scene. Intent names must be unique within an Actions project.

Global intents can be matched anytime during a session, allowing users to access common flows like "get help" or "go back home." They can also be used to deep link users into specific flows when they invoke an Action.

Note, the intent name is specified in the name of the file.

type GlobalIntentEvent struct {

    // Optional. Destination scene which the conversation should jump to. The state of the
    // current scene is destroyed on the transition.
    TransitionToScene string `protobuf:"bytes,1,opt,name=transition_to_scene,json=transitionToScene,proto3" json:"transition_to_scene,omitempty"`
    // Optional. Event handler which is triggered when the intent is matched. Should execute
    // before transitioning to the destination scene. Useful to generate Prompts
    // in response to events.
    Handler *EventHandler `protobuf:"bytes,2,opt,name=handler,proto3" json:"handler,omitempty"`
    // contains filtered or unexported fields
}

func (*GlobalIntentEvent) Descriptor

func (*GlobalIntentEvent) Descriptor() ([]byte, []int)

Deprecated: Use GlobalIntentEvent.ProtoReflect.Descriptor instead.

func (*GlobalIntentEvent) GetHandler

func (x *GlobalIntentEvent) GetHandler() *EventHandler

func (*GlobalIntentEvent) GetTransitionToScene

func (x *GlobalIntentEvent) GetTransitionToScene() string

func (*GlobalIntentEvent) ProtoMessage

func (*GlobalIntentEvent) ProtoMessage()

func (*GlobalIntentEvent) ProtoReflect

func (x *GlobalIntentEvent) ProtoReflect() protoreflect.Message

func (*GlobalIntentEvent) Reset

func (x *GlobalIntentEvent) Reset()

func (*GlobalIntentEvent) String

func (x *GlobalIntentEvent) String() string

type Intent

Intents map open-ended user input to structured objects. Spoken phrases are matched to intents with Google's Natural Language Understanding (NLU). Intent matches can trigger events in your conversation design to progress the user's conversation. The intent name is specified in the name of the file.

type Intent struct {

    // The list of parameters within the training phrases. All parameters must be
    // defined here to be used in the training phrase.
    Parameters []*Intent_IntentParameter `protobuf:"bytes,1,rep,name=parameters,proto3" json:"parameters,omitempty"`
    // Training phrases allow Google’s NLU to automatically match intents with
    // user input. The more unique phrases that are provided, the better chance
    // this intent will be matched.
    // The following is the format of training phrase part which are annotated.
    // Note that `auto` field is optional and the default behavior when `auto` is
    // not specified is equivalent to `auto=false`.
    // `($<paramName> '<sample text>' auto=<true or false>)`
    // `auto = true` means the part was auto annotated by NLU.
    // `auto = false` means the part was annotated by the user. This is the
    //
    //	default when auto is not specified.
    //
    // Example:
    // "Book a flight from ($source 'San Francisco' auto=false) to ($dest
    // 'Vancouver')"
    TrainingPhrases []string `protobuf:"bytes,2,rep,name=training_phrases,json=trainingPhrases,proto3" json:"training_phrases,omitempty"`
    // contains filtered or unexported fields
}

func (*Intent) Descriptor

func (*Intent) Descriptor() ([]byte, []int)

Deprecated: Use Intent.ProtoReflect.Descriptor instead.

func (*Intent) GetParameters

func (x *Intent) GetParameters() []*Intent_IntentParameter

func (*Intent) GetTrainingPhrases

func (x *Intent) GetTrainingPhrases() []string

func (*Intent) ProtoMessage

func (*Intent) ProtoMessage()

func (*Intent) ProtoReflect

func (x *Intent) ProtoReflect() protoreflect.Message

func (*Intent) Reset

func (x *Intent) Reset()

func (*Intent) String

func (x *Intent) String() string

type IntentEvent

Registers Events which trigger as the result of an intent match.

type IntentEvent struct {

    // Required. Intent triggering the event.
    Intent string `protobuf:"bytes,1,opt,name=intent,proto3" json:"intent,omitempty"`
    // Optional. Destination scene which the conversation should jump to. The state of the
    // current scene is destroyed on the transition.
    TransitionToScene string `protobuf:"bytes,2,opt,name=transition_to_scene,json=transitionToScene,proto3" json:"transition_to_scene,omitempty"`
    // Optional. Event handler which is triggered when the intent is matched. Should execute
    // before transitioning to the destination scene. Useful to generate prompts
    // in response to events.
    Handler *EventHandler `protobuf:"bytes,3,opt,name=handler,proto3" json:"handler,omitempty"`
    // contains filtered or unexported fields
}

func (*IntentEvent) Descriptor

func (*IntentEvent) Descriptor() ([]byte, []int)

Deprecated: Use IntentEvent.ProtoReflect.Descriptor instead.

func (*IntentEvent) GetHandler

func (x *IntentEvent) GetHandler() *EventHandler

func (*IntentEvent) GetIntent

func (x *IntentEvent) GetIntent() string

func (*IntentEvent) GetTransitionToScene

func (x *IntentEvent) GetTransitionToScene() string

func (*IntentEvent) ProtoMessage

func (*IntentEvent) ProtoMessage()

func (*IntentEvent) ProtoReflect

func (x *IntentEvent) ProtoReflect() protoreflect.Message

func (*IntentEvent) Reset

func (x *IntentEvent) Reset()

func (*IntentEvent) String

func (x *IntentEvent) String() string

type Intent_IntentParameter

Definition of a parameter which can be used inside training phrases.

type Intent_IntentParameter struct {

    // Required. Unique name of the intent parameter. Can be used in conditions and
    // responses to reference intent parameters extracted by NLU with
    // $intent.params.[name].resolved
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // The type of the intent parameter.
    //
    // Types that are assignable to ParameterType:
    //
    //	*Intent_IntentParameter_Type
    //	*Intent_IntentParameter_EntitySetReferences_
    ParameterType isIntent_IntentParameter_ParameterType `protobuf_oneof:"parameter_type"`
    // contains filtered or unexported fields
}

func (*Intent_IntentParameter) Descriptor

func (*Intent_IntentParameter) Descriptor() ([]byte, []int)

Deprecated: Use Intent_IntentParameter.ProtoReflect.Descriptor instead.

func (*Intent_IntentParameter) GetEntitySetReferences

func (x *Intent_IntentParameter) GetEntitySetReferences() *Intent_IntentParameter_EntitySetReferences

func (*Intent_IntentParameter) GetName

func (x *Intent_IntentParameter) GetName() string

func (*Intent_IntentParameter) GetParameterType

func (m *Intent_IntentParameter) GetParameterType() isIntent_IntentParameter_ParameterType

func (*Intent_IntentParameter) GetType

func (x *Intent_IntentParameter) GetType() *_type.ClassReference

func (*Intent_IntentParameter) ProtoMessage

func (*Intent_IntentParameter) ProtoMessage()

func (*Intent_IntentParameter) ProtoReflect

func (x *Intent_IntentParameter) ProtoReflect() protoreflect.Message

func (*Intent_IntentParameter) Reset

func (x *Intent_IntentParameter) Reset()

func (*Intent_IntentParameter) String

func (x *Intent_IntentParameter) String() string

type Intent_IntentParameter_EntitySetReferences

Entity set references for an intent parameter.

type Intent_IntentParameter_EntitySetReferences struct {

    // Required. Entity set references for an intent parameter.
    EntitySetReferences []*Intent_IntentParameter_EntitySetReferences_EntitySetReference `protobuf:"bytes,1,rep,name=entity_set_references,json=entitySetReferences,proto3" json:"entity_set_references,omitempty"`
    // contains filtered or unexported fields
}

func (*Intent_IntentParameter_EntitySetReferences) Descriptor

func (*Intent_IntentParameter_EntitySetReferences) Descriptor() ([]byte, []int)

Deprecated: Use Intent_IntentParameter_EntitySetReferences.ProtoReflect.Descriptor instead.

func (*Intent_IntentParameter_EntitySetReferences) GetEntitySetReferences

func (x *Intent_IntentParameter_EntitySetReferences) GetEntitySetReferences() []*Intent_IntentParameter_EntitySetReferences_EntitySetReference

func (*Intent_IntentParameter_EntitySetReferences) ProtoMessage

func (*Intent_IntentParameter_EntitySetReferences) ProtoMessage()

func (*Intent_IntentParameter_EntitySetReferences) ProtoReflect

func (x *Intent_IntentParameter_EntitySetReferences) ProtoReflect() protoreflect.Message

func (*Intent_IntentParameter_EntitySetReferences) Reset

func (x *Intent_IntentParameter_EntitySetReferences) Reset()

func (*Intent_IntentParameter_EntitySetReferences) String

func (x *Intent_IntentParameter_EntitySetReferences) String() string

type Intent_IntentParameter_EntitySetReferences_

type Intent_IntentParameter_EntitySetReferences_ struct {
    // Optional. References to the sets of allowed entities for this intent parameter.
    // Only valid for parameters of a built-in intent. These
    // references point to entity sets in the 'custom/entitySets' directory.
    EntitySetReferences *Intent_IntentParameter_EntitySetReferences `protobuf:"bytes,3,opt,name=entity_set_references,json=entitySetReferences,proto3,oneof"`
}

type Intent_IntentParameter_EntitySetReferences_EntitySetReference

A reference to the set of allowed entities for this intent parameter.

type Intent_IntentParameter_EntitySetReferences_EntitySetReference struct {

    // Required. Identifies the specific collection of entities to be considered for a
    // given parameter. The corresponding entity set definition should be
    // present in the custom/entitySets/ directory.
    EntitySet string `protobuf:"bytes,1,opt,name=entity_set,json=entitySet,proto3" json:"entity_set,omitempty"`
    // contains filtered or unexported fields
}

func (*Intent_IntentParameter_EntitySetReferences_EntitySetReference) Descriptor

func (*Intent_IntentParameter_EntitySetReferences_EntitySetReference) Descriptor() ([]byte, []int)

Deprecated: Use Intent_IntentParameter_EntitySetReferences_EntitySetReference.ProtoReflect.Descriptor instead.

func (*Intent_IntentParameter_EntitySetReferences_EntitySetReference) GetEntitySet

func (x *Intent_IntentParameter_EntitySetReferences_EntitySetReference) GetEntitySet() string

func (*Intent_IntentParameter_EntitySetReferences_EntitySetReference) ProtoMessage

func (*Intent_IntentParameter_EntitySetReferences_EntitySetReference) ProtoMessage()

func (*Intent_IntentParameter_EntitySetReferences_EntitySetReference) ProtoReflect

func (x *Intent_IntentParameter_EntitySetReferences_EntitySetReference) ProtoReflect() protoreflect.Message

func (*Intent_IntentParameter_EntitySetReferences_EntitySetReference) Reset

func (x *Intent_IntentParameter_EntitySetReferences_EntitySetReference) Reset()

func (*Intent_IntentParameter_EntitySetReferences_EntitySetReference) String

func (x *Intent_IntentParameter_EntitySetReferences_EntitySetReference) String() string

type Intent_IntentParameter_Type

type Intent_IntentParameter_Type struct {
    // Optional. Declares the data type of this parameter.
    // This should not be set for built-in intents.
    Type *_type.ClassReference `protobuf:"bytes,2,opt,name=type,proto3,oneof"`
}

type Scene

Scene is the basic unit of control flow when designing a conversation. They can be chained together with other scenes, generate prompts for the end user, and define slots. The scene name is specified in the name of the file.

type Scene struct {

    // Handler to invoke when transitioning into this scene.
    OnEnter *EventHandler `protobuf:"bytes,1,opt,name=on_enter,json=onEnter,proto3" json:"on_enter,omitempty"`
    // The list of events that trigger based on intents. These events can
    // be triggered at any time after the on_load Handler has been called.
    // Important - these events define the set of intents which are scoped to
    // this scene and will take precedence over any globally defined events that
    // have the same intents or their triggering phrases. Intent names must be
    // unique within a scene.
    IntentEvents []*IntentEvent `protobuf:"bytes,2,rep,name=intent_events,json=intentEvents,proto3" json:"intent_events,omitempty"`
    // The list of events to trigger based on conditional statements. These are
    // evaluated after the form has been filled or immediately after on_load if
    // this scene does not have a form (evaluation is only done once). Only the
    // first matching event will be triggered.
    ConditionalEvents []*ConditionalEvent `protobuf:"bytes,3,rep,name=conditional_events,json=conditionalEvents,proto3" json:"conditional_events,omitempty"`
    // Ordered list of slots. Each slot defines the type of data
    // that it will resolve and configuration to customize the experience of this
    // resolution (e.g. prompts).
    Slots []*Slot `protobuf:"bytes,4,rep,name=slots,proto3" json:"slots,omitempty"`
    // Handler called when there is a change in state of a slot not
    // caused by updates within another Handler. This allows slots to be
    // invalidated, the scene invalidated or other changes to scene state.
    OnSlotUpdated *EventHandler `protobuf:"bytes,5,opt,name=on_slot_updated,json=onSlotUpdated,proto3" json:"on_slot_updated,omitempty"`
    // contains filtered or unexported fields
}

func (*Scene) Descriptor

func (*Scene) Descriptor() ([]byte, []int)

Deprecated: Use Scene.ProtoReflect.Descriptor instead.

func (*Scene) GetConditionalEvents

func (x *Scene) GetConditionalEvents() []*ConditionalEvent

func (*Scene) GetIntentEvents

func (x *Scene) GetIntentEvents() []*IntentEvent

func (*Scene) GetOnEnter

func (x *Scene) GetOnEnter() *EventHandler

func (*Scene) GetOnSlotUpdated

func (x *Scene) GetOnSlotUpdated() *EventHandler

func (*Scene) GetSlots

func (x *Scene) GetSlots() []*Slot

func (*Scene) ProtoMessage

func (*Scene) ProtoMessage()

func (*Scene) ProtoReflect

func (x *Scene) ProtoReflect() protoreflect.Message

func (*Scene) Reset

func (x *Scene) Reset()

func (*Scene) String

func (x *Scene) String() string

type Slot

Configuration for a slot. Slots are single units of data that can be filled through natural language (ie. intent parameters), session parameters, and other sources.

type Slot struct {

    // Required. Name of the slot.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // Required. Declares the data type of this slot.
    Type *_type.ClassReference `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
    // Optional. Indicates whether the slot is required to be filled before
    // advancing. Required slots that are not filled will trigger a customizable
    // prompt to the user.
    Required bool `protobuf:"varint,3,opt,name=required,proto3" json:"required,omitempty"`
    // Optional. Registers Prompts for different stages of slot filling.
    PromptSettings *Slot_PromptSettings `protobuf:"bytes,4,opt,name=prompt_settings,json=promptSettings,proto3" json:"prompt_settings,omitempty"`
    // Optional. Commit behavior associated with the slot.
    CommitBehavior *Slot_CommitBehavior `protobuf:"bytes,5,opt,name=commit_behavior,json=commitBehavior,proto3" json:"commit_behavior,omitempty"`
    // Optional. Additional configuration associated with the slot which is
    // used for filling the slot. The format of the config is specific to the
    // type of the slot. Resource references to user or session parameter can be
    // added to this config. This config is needed for filling slots related to
    // transactions and user engagement.
    //
    // Example:
    //
    //	For a slot of type actions.type.CompletePurchaseValue, the following
    //	config proposes a digital good order with a reference to a client defined
    //	session parameter `userSelectedSkuId`:
    //
    //	  {
    //	    "@type": "type.googleapis.com/
    //	                google.actions.transactions.v3.CompletePurchaseValueSpec",
    //	    "skuId": {
    //	      "skuType": "SKU_TYPE_IN_APP",
    //	      "id": "$session.params.userSelectedSkuId",
    //	      "packageName": "com.example.company"
    //	    }
    //	  }
    Config *structpb.Value `protobuf:"bytes,6,opt,name=config,proto3" json:"config,omitempty"`
    // Optional. Configuration to populate a default value for this slot.
    DefaultValue *Slot_DefaultValue `protobuf:"bytes,7,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
    // contains filtered or unexported fields
}

func (*Slot) Descriptor

func (*Slot) Descriptor() ([]byte, []int)

Deprecated: Use Slot.ProtoReflect.Descriptor instead.

func (*Slot) GetCommitBehavior

func (x *Slot) GetCommitBehavior() *Slot_CommitBehavior

func (*Slot) GetConfig

func (x *Slot) GetConfig() *structpb.Value

func (*Slot) GetDefaultValue

func (x *Slot) GetDefaultValue() *Slot_DefaultValue

func (*Slot) GetName

func (x *Slot) GetName() string

func (*Slot) GetPromptSettings

func (x *Slot) GetPromptSettings() *Slot_PromptSettings

func (*Slot) GetRequired

func (x *Slot) GetRequired() bool

func (*Slot) GetType

func (x *Slot) GetType() *_type.ClassReference

func (*Slot) ProtoMessage

func (*Slot) ProtoMessage()

func (*Slot) ProtoReflect

func (x *Slot) ProtoReflect() protoreflect.Message

func (*Slot) Reset

func (x *Slot) Reset()

func (*Slot) String

func (x *Slot) String() string

type Slot_CommitBehavior

Message describing the commit behavior associated with the slot after it has been successfully filled.

type Slot_CommitBehavior struct {

    // The session parameter to write the slot value after it is filled. Note
    // that nested paths are not currently supported. "$$" is used to write the
    // slot value to a session parameter with same name as the slot.
    // Eg: write_session_param = "fruit" corresponds to "$session.params.fruit".
    // write_session_param = "ticket" corresponds to "$session.params.ticket".
    WriteSessionParam string `protobuf:"bytes,1,opt,name=write_session_param,json=writeSessionParam,proto3" json:"write_session_param,omitempty"`
    // contains filtered or unexported fields
}

func (*Slot_CommitBehavior) Descriptor

func (*Slot_CommitBehavior) Descriptor() ([]byte, []int)

Deprecated: Use Slot_CommitBehavior.ProtoReflect.Descriptor instead.

func (*Slot_CommitBehavior) GetWriteSessionParam

func (x *Slot_CommitBehavior) GetWriteSessionParam() string

func (*Slot_CommitBehavior) ProtoMessage

func (*Slot_CommitBehavior) ProtoMessage()

func (*Slot_CommitBehavior) ProtoReflect

func (x *Slot_CommitBehavior) ProtoReflect() protoreflect.Message

func (*Slot_CommitBehavior) Reset

func (x *Slot_CommitBehavior) Reset()

func (*Slot_CommitBehavior) String

func (x *Slot_CommitBehavior) String() string

type Slot_DefaultValue

Configuration to populate a default value for this slot.

type Slot_DefaultValue struct {

    // Optional. The session parameter to be used to initialize the slot value, if it has
    // a non-empty value. The type of the value must match the type of the slot.
    // Note that nested paths are not currently supported.
    // Eg: `session_param = "fruit"` corresponds to `$session.params.fruit`.
    // `session_param = "ticket"` corresponds to `$session.params.ticket`.
    SessionParam string `protobuf:"bytes,1,opt,name=session_param,json=sessionParam,proto3" json:"session_param,omitempty"`
    // Optional. Constant default value for the slot. This will only be used if a value
    // for this slot was not populated through the `session_param`. The
    // type for this value must match the type of the slot.
    Constant *structpb.Value `protobuf:"bytes,2,opt,name=constant,proto3" json:"constant,omitempty"`
    // contains filtered or unexported fields
}

func (*Slot_DefaultValue) Descriptor

func (*Slot_DefaultValue) Descriptor() ([]byte, []int)

Deprecated: Use Slot_DefaultValue.ProtoReflect.Descriptor instead.

func (*Slot_DefaultValue) GetConstant

func (x *Slot_DefaultValue) GetConstant() *structpb.Value

func (*Slot_DefaultValue) GetSessionParam

func (x *Slot_DefaultValue) GetSessionParam() string

func (*Slot_DefaultValue) ProtoMessage

func (*Slot_DefaultValue) ProtoMessage()

func (*Slot_DefaultValue) ProtoReflect

func (x *Slot_DefaultValue) ProtoReflect() protoreflect.Message

func (*Slot_DefaultValue) Reset

func (x *Slot_DefaultValue) Reset()

func (*Slot_DefaultValue) String

func (x *Slot_DefaultValue) String() string

type Slot_PromptSettings

A single place where slot prompts are defined.

type Slot_PromptSettings struct {

    // Prompt for the slot value itself. Example: "What size did you want?"
    InitialPrompt *EventHandler `protobuf:"bytes,1,opt,name=initial_prompt,json=initialPrompt,proto3" json:"initial_prompt,omitempty"`
    // Prompt to give when the user's input does not match the expected
    // value type for the slot for the first time. Example: "Sorry, I
    // didn't get that."
    NoMatchPrompt1 *EventHandler `protobuf:"bytes,2,opt,name=no_match_prompt1,json=noMatchPrompt1,proto3" json:"no_match_prompt1,omitempty"`
    // Prompt to give when the user's input does not match the expected
    // value type for the slot for the second time. Example: "Sorry, I
    // didn't get that."
    NoMatchPrompt2 *EventHandler `protobuf:"bytes,3,opt,name=no_match_prompt2,json=noMatchPrompt2,proto3" json:"no_match_prompt2,omitempty"`
    // Prompt to give when the user's input does not match the expected
    // value type for the slot for the last time. Example: "Sorry, I
    // didn't get that."
    NoMatchFinalPrompt *EventHandler `protobuf:"bytes,4,opt,name=no_match_final_prompt,json=noMatchFinalPrompt,proto3" json:"no_match_final_prompt,omitempty"`
    // Prompt to give when the user does not provide an input for the first
    // time. Example: "Sorry, I didn't get that."
    NoInputPrompt1 *EventHandler `protobuf:"bytes,5,opt,name=no_input_prompt1,json=noInputPrompt1,proto3" json:"no_input_prompt1,omitempty"`
    // Prompt to give when the user does not provide an input for the second
    // time. Example: "Sorry, I didn't get that."
    NoInputPrompt2 *EventHandler `protobuf:"bytes,6,opt,name=no_input_prompt2,json=noInputPrompt2,proto3" json:"no_input_prompt2,omitempty"`
    // Prompt to give when the user does not provide an input for the last
    // time. Example: "Sorry, I didn't get that."
    NoInputFinalPrompt *EventHandler `protobuf:"bytes,7,opt,name=no_input_final_prompt,json=noInputFinalPrompt,proto3" json:"no_input_final_prompt,omitempty"`
    // contains filtered or unexported fields
}

func (*Slot_PromptSettings) Descriptor

func (*Slot_PromptSettings) Descriptor() ([]byte, []int)

Deprecated: Use Slot_PromptSettings.ProtoReflect.Descriptor instead.

func (*Slot_PromptSettings) GetInitialPrompt

func (x *Slot_PromptSettings) GetInitialPrompt() *EventHandler

func (*Slot_PromptSettings) GetNoInputFinalPrompt

func (x *Slot_PromptSettings) GetNoInputFinalPrompt() *EventHandler

func (*Slot_PromptSettings) GetNoInputPrompt1

func (x *Slot_PromptSettings) GetNoInputPrompt1() *EventHandler

func (*Slot_PromptSettings) GetNoInputPrompt2

func (x *Slot_PromptSettings) GetNoInputPrompt2() *EventHandler

func (*Slot_PromptSettings) GetNoMatchFinalPrompt

func (x *Slot_PromptSettings) GetNoMatchFinalPrompt() *EventHandler

func (*Slot_PromptSettings) GetNoMatchPrompt1

func (x *Slot_PromptSettings) GetNoMatchPrompt1() *EventHandler

func (*Slot_PromptSettings) GetNoMatchPrompt2

func (x *Slot_PromptSettings) GetNoMatchPrompt2() *EventHandler

func (*Slot_PromptSettings) ProtoMessage

func (*Slot_PromptSettings) ProtoMessage()

func (*Slot_PromptSettings) ProtoReflect

func (x *Slot_PromptSettings) ProtoReflect() protoreflect.Message

func (*Slot_PromptSettings) Reset

func (x *Slot_PromptSettings) Reset()

func (*Slot_PromptSettings) String

func (x *Slot_PromptSettings) String() string

Subdirectories

Name Synopsis
..
prompt
type