Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	SynonymType_MatchType_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "EXACT_MATCH",
		2: "FUZZY_MATCH",
	}
	SynonymType_MatchType_value = map[string]int32{
		"UNSPECIFIED": 0,
		"EXACT_MATCH": 1,
		"FUZZY_MATCH": 2,
	}
)

Enum value maps for SynonymType_MatchType.

View Source
var File_google_actions_sdk_v2_interactionmodel_type_class_reference_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_interactionmodel_type_entity_display_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_interactionmodel_type_free_text_type_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_interactionmodel_type_regular_expression_type_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_interactionmodel_type_synonym_type_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_interactionmodel_type_type_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ClassReference

type ClassReference struct {

	// Required. Name of a built-in type or custom type of the parameter. Examples:
	// `PizzaToppings`, `actions.type.Number`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Indicates whether the data type represents a list of values.
	List bool `protobuf:"varint,2,opt,name=list,proto3" json:"list,omitempty"`
	// contains filtered or unexported fields
}

A reference to a class which is used to declare the type of a field or return value. Enums are also a type of class that can be referenced using ClassReference.

func (*ClassReference) Descriptor

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

Deprecated: Use ClassReference.ProtoReflect.Descriptor instead.

func (*ClassReference) GetList

func (x *ClassReference) GetList() bool

func (*ClassReference) GetName

func (x *ClassReference) GetName() string

func (*ClassReference) ProtoMessage

func (*ClassReference) ProtoMessage()

func (*ClassReference) ProtoReflect

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

func (*ClassReference) Reset

func (x *ClassReference) Reset()

func (*ClassReference) String

func (x *ClassReference) String() string

type EntityDisplay

type EntityDisplay struct {

	// Optional. Title of the icon.
	IconTitle string `protobuf:"bytes,1,opt,name=icon_title,json=iconTitle,proto3" json:"icon_title,omitempty"`
	// Required. Url of the icon.
	IconUrl string `protobuf:"bytes,2,opt,name=icon_url,json=iconUrl,proto3" json:"icon_url,omitempty"`
	// contains filtered or unexported fields
}

Elements that will be displayed on the canvas once a particular type's entity is extracted from a query. Only relevant for canvas enabled apps. **This message is localizable.**

func (*EntityDisplay) Descriptor

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

Deprecated: Use EntityDisplay.ProtoReflect.Descriptor instead.

func (*EntityDisplay) GetIconTitle

func (x *EntityDisplay) GetIconTitle() string

func (*EntityDisplay) GetIconUrl

func (x *EntityDisplay) GetIconUrl() string

func (*EntityDisplay) ProtoMessage

func (*EntityDisplay) ProtoMessage()

func (*EntityDisplay) ProtoReflect

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

func (*EntityDisplay) Reset

func (x *EntityDisplay) Reset()

func (*EntityDisplay) String

func (x *EntityDisplay) String() string

type FreeTextType

type FreeTextType struct {

	// Optional. Elements that will be displayed on the canvas once an entity is extracted
	// from a query. Only relevant for canvas enabled apps.
	Display *EntityDisplay `protobuf:"bytes,2,opt,name=display,proto3" json:"display,omitempty"`
	// contains filtered or unexported fields
}

Type that matches any text if surrounding words context is close to provided training examples.

func (*FreeTextType) Descriptor

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

Deprecated: Use FreeTextType.ProtoReflect.Descriptor instead.

func (*FreeTextType) GetDisplay

func (x *FreeTextType) GetDisplay() *EntityDisplay

func (*FreeTextType) ProtoMessage

func (*FreeTextType) ProtoMessage()

func (*FreeTextType) ProtoReflect

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

func (*FreeTextType) Reset

func (x *FreeTextType) Reset()

func (*FreeTextType) String

func (x *FreeTextType) String() string

type RegularExpressionType

type RegularExpressionType struct {

	// Required. Named map of entities which each contain Regex strings.
	Entities map[string]*RegularExpressionType_Entity `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

Type that matches text by regular expressions. **This message is localizable.**

func (*RegularExpressionType) Descriptor

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

Deprecated: Use RegularExpressionType.ProtoReflect.Descriptor instead.

func (*RegularExpressionType) GetEntities

func (*RegularExpressionType) ProtoMessage

func (*RegularExpressionType) ProtoMessage()

func (*RegularExpressionType) ProtoReflect

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

func (*RegularExpressionType) Reset

func (x *RegularExpressionType) Reset()

func (*RegularExpressionType) String

func (x *RegularExpressionType) String() string

type RegularExpressionType_Entity

type RegularExpressionType_Entity struct {

	// Optional. Elements that will be displayed on the canvas once an entity is
	// extracted from a query. Only relevant for canvas enabled apps.
	Display *EntityDisplay `protobuf:"bytes,1,opt,name=display,proto3" json:"display,omitempty"`
	// Required. Uses RE2 regex syntax (See
	// https://github.com/google/re2/wiki/Syntax for more details)
	RegularExpressions []string `protobuf:"bytes,2,rep,name=regular_expressions,json=regularExpressions,proto3" json:"regular_expressions,omitempty"`
	// contains filtered or unexported fields
}

Represents an entity object that contains the regular expression that is used for comparison.

func (*RegularExpressionType_Entity) Descriptor

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

Deprecated: Use RegularExpressionType_Entity.ProtoReflect.Descriptor instead.

func (*RegularExpressionType_Entity) GetDisplay

func (*RegularExpressionType_Entity) GetRegularExpressions

func (x *RegularExpressionType_Entity) GetRegularExpressions() []string

func (*RegularExpressionType_Entity) ProtoMessage

func (*RegularExpressionType_Entity) ProtoMessage()

func (*RegularExpressionType_Entity) ProtoReflect

func (*RegularExpressionType_Entity) Reset

func (x *RegularExpressionType_Entity) Reset()

func (*RegularExpressionType_Entity) String

type SynonymType

type SynonymType struct {

	// Optional. The match type for the synonym.
	MatchType SynonymType_MatchType `` /* 160-byte string literal not displayed */
	// Optional. When set to true this will match unknown words or phrases based on
	// surrounding input and intent training data, such as items that might be
	// added to a grocery list.
	AcceptUnknownValues bool `protobuf:"varint,3,opt,name=accept_unknown_values,json=acceptUnknownValues,proto3" json:"accept_unknown_values,omitempty"`
	// Required. Named map of synonym entities.
	Entities map[string]*SynonymType_Entity `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

Type that matches text by set of synonyms.

func (*SynonymType) Descriptor

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

Deprecated: Use SynonymType.ProtoReflect.Descriptor instead.

func (*SynonymType) GetAcceptUnknownValues

func (x *SynonymType) GetAcceptUnknownValues() bool

func (*SynonymType) GetEntities

func (x *SynonymType) GetEntities() map[string]*SynonymType_Entity

func (*SynonymType) GetMatchType

func (x *SynonymType) GetMatchType() SynonymType_MatchType

func (*SynonymType) ProtoMessage

func (*SynonymType) ProtoMessage()

func (*SynonymType) ProtoReflect

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

func (*SynonymType) Reset

func (x *SynonymType) Reset()

func (*SynonymType) String

func (x *SynonymType) String() string

type SynonymType_Entity

type SynonymType_Entity struct {

	// Optional. The entity display details.
	Display *EntityDisplay `protobuf:"bytes,1,opt,name=display,proto3" json:"display,omitempty"`
	// Optional. The list of synonyms for the entity.
	// **This field is localizable.**
	Synonyms []string `protobuf:"bytes,2,rep,name=synonyms,proto3" json:"synonyms,omitempty"`
	// contains filtered or unexported fields
}

Represents a synonym entity field that contains the details of a single entry inside the type.

func (*SynonymType_Entity) Descriptor

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

Deprecated: Use SynonymType_Entity.ProtoReflect.Descriptor instead.

func (*SynonymType_Entity) GetDisplay

func (x *SynonymType_Entity) GetDisplay() *EntityDisplay

func (*SynonymType_Entity) GetSynonyms

func (x *SynonymType_Entity) GetSynonyms() []string

func (*SynonymType_Entity) ProtoMessage

func (*SynonymType_Entity) ProtoMessage()

func (*SynonymType_Entity) ProtoReflect

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

func (*SynonymType_Entity) Reset

func (x *SynonymType_Entity) Reset()

func (*SynonymType_Entity) String

func (x *SynonymType_Entity) String() string

type SynonymType_MatchType

type SynonymType_MatchType int32

The type of matching that entries in this type will use. This will ensure all of the types use the same matching method and allow variation of matching for synonym matching (i.e. fuzzy versus exact). If the value is `UNSPECIFIED` it will be defaulted to `EXACT_MATCH`.

const (
	// Defaults to `EXACT_MATCH`.
	SynonymType_UNSPECIFIED SynonymType_MatchType = 0
	// Looks for an exact match of the synonym or name.
	SynonymType_EXACT_MATCH SynonymType_MatchType = 1
	// Looser than `EXACT_MATCH`. Looks for similar matches as well as exact
	// matches.
	SynonymType_FUZZY_MATCH SynonymType_MatchType = 2
)

func (SynonymType_MatchType) Descriptor

func (SynonymType_MatchType) Enum

func (SynonymType_MatchType) EnumDescriptor

func (SynonymType_MatchType) EnumDescriptor() ([]byte, []int)

Deprecated: Use SynonymType_MatchType.Descriptor instead.

func (SynonymType_MatchType) Number

func (SynonymType_MatchType) String

func (x SynonymType_MatchType) String() string

func (SynonymType_MatchType) Type

type Type

type Type struct {

	// Selection of sub type based on the type of matching to be done.
	//
	// Types that are assignable to SubType:
	//	*Type_Synonym
	//	*Type_RegularExpression
	//	*Type_FreeText
	SubType isType_SubType `protobuf_oneof:"sub_type"`
	// Set of exceptional words/phrases that shouldn't be matched by type.
	// Note: If word/phrase is matched by the type but listed as an exclusion it
	// won't be returned in parameter extraction result.
	// **This field is localizable.**
	Exclusions []string `protobuf:"bytes,4,rep,name=exclusions,proto3" json:"exclusions,omitempty"`
	// contains filtered or unexported fields
}

Declaration of a custom type, as opposed to built-in types. Types can be assigned to slots in a scene or parameters of an intent's training phrases. Practically, Types can be thought of as enums. Note, type name is specified in the name of the file.

func (*Type) Descriptor

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

Deprecated: Use Type.ProtoReflect.Descriptor instead.

func (*Type) GetExclusions

func (x *Type) GetExclusions() []string

func (*Type) GetFreeText

func (x *Type) GetFreeText() *FreeTextType

func (*Type) GetRegularExpression

func (x *Type) GetRegularExpression() *RegularExpressionType

func (*Type) GetSubType

func (m *Type) GetSubType() isType_SubType

func (*Type) GetSynonym

func (x *Type) GetSynonym() *SynonymType

func (*Type) ProtoMessage

func (*Type) ProtoMessage()

func (*Type) ProtoReflect

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

func (*Type) Reset

func (x *Type) Reset()

func (*Type) String

func (x *Type) String() string

type Type_FreeText

type Type_FreeText struct {
	// FreeText type.
	FreeText *FreeTextType `protobuf:"bytes,3,opt,name=free_text,json=freeText,proto3,oneof"`
}

type Type_RegularExpression

type Type_RegularExpression struct {
	// Regex type, allows regular expression matching.
	RegularExpression *RegularExpressionType `protobuf:"bytes,2,opt,name=regular_expression,json=regularExpression,proto3,oneof"`
}

type Type_Synonym

type Type_Synonym struct {
	// Synonyms type, which is essentially an enum.
	Synonym *SynonymType `protobuf:"bytes,1,opt,name=synonym,proto3,oneof"`
}