conversation

package
v0.0.0-...-3abc09e Latest Latest
Warning

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

Go to latest
Published: Dec 23, 2024 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Image_ImageFill_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "GRAY",
		2: "WHITE",
		3: "CROPPED",
	}
	Image_ImageFill_value = map[string]int32{
		"UNSPECIFIED": 0,
		"GRAY":        1,
		"WHITE":       2,
		"CROPPED":     3,
	}
)

Enum value maps for Image_ImageFill.

View Source
var (
	UrlHint_name = map[int32]string{
		0: "LINK_UNSPECIFIED",
		1: "AMP",
	}
	UrlHint_value = map[string]int32{
		"LINK_UNSPECIFIED": 0,
		"AMP":              1,
	}
)

Enum value maps for UrlHint.

View Source
var (
	Media_MediaType_name = map[int32]string{
		0: "MEDIA_TYPE_UNSPECIFIED",
		1: "AUDIO",
		2: "MEDIA_STATUS_ACK",
	}
	Media_MediaType_value = map[string]int32{
		"MEDIA_TYPE_UNSPECIFIED": 0,
		"AUDIO":                  1,
		"MEDIA_STATUS_ACK":       2,
	}
)

Enum value maps for Media_MediaType.

View Source
var (
	Media_OptionalMediaControls_name = map[int32]string{
		0: "OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED",
		1: "PAUSED",
		2: "STOPPED",
	}
	Media_OptionalMediaControls_value = map[string]int32{
		"OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED": 0,
		"PAUSED":                              1,
		"STOPPED":                             2,
	}
)

Enum value maps for Media_OptionalMediaControls.

View Source
var (
	SlotFillingStatus_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "INITIALIZED",
		2: "COLLECTING",
		4: "FINAL",
	}
	SlotFillingStatus_value = map[string]int32{
		"UNSPECIFIED": 0,
		"INITIALIZED": 1,
		"COLLECTING":  2,
		"FINAL":       4,
	}
)

Enum value maps for SlotFillingStatus.

View Source
var (
	Slot_SlotMode_name = map[int32]string{
		0: "MODE_UNSPECIFIED",
		1: "OPTIONAL",
		2: "REQUIRED",
	}
	Slot_SlotMode_value = map[string]int32{
		"MODE_UNSPECIFIED": 0,
		"OPTIONAL":         1,
		"REQUIRED":         2,
	}
)

Enum value maps for Slot_SlotMode.

View Source
var (
	Slot_SlotStatus_name = map[int32]string{
		0: "SLOT_UNSPECIFIED",
		1: "EMPTY",
		2: "INVALID",
		3: "FILLED",
	}
	Slot_SlotStatus_value = map[string]int32{
		"SLOT_UNSPECIFIED": 0,
		"EMPTY":            1,
		"INVALID":          2,
		"FILLED":           3,
	}
)

Enum value maps for Slot_SlotStatus.

View Source
var (
	TableColumn_HorizontalAlignment_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "LEADING",
		2: "CENTER",
		3: "TRAILING",
	}
	TableColumn_HorizontalAlignment_value = map[string]int32{
		"UNSPECIFIED": 0,
		"LEADING":     1,
		"CENTER":      2,
		"TRAILING":    3,
	}
)

Enum value maps for TableColumn_HorizontalAlignment.

View Source
var File_google_actions_sdk_v2_conversation_intent_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_prompt_content_canvas_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_prompt_content_card_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_prompt_content_collection_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_prompt_content_content_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_prompt_content_image_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_prompt_content_link_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_prompt_content_list_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_prompt_content_media_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_prompt_content_table_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_prompt_prompt_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_prompt_simple_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_prompt_suggestion_proto protoreflect.FileDescriptor
View Source
var File_google_actions_sdk_v2_conversation_scene_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Canvas

type Canvas struct {

	// URL of the interactive canvas web app to load. If not set, the url from
	// current active canvas will be reused.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// Optional. JSON data to be passed through to the immersive experience
	// web page as an event.
	// If the "override" field in the containing prompt is "false" data values
	// defined in this Canvas prompt will be added after data values defined in
	// previous Canvas prompts.
	Data []*structpb.Value `protobuf:"bytes,4,rep,name=data,proto3" json:"data,omitempty"`
	// Optional. Default value: false.
	SuppressMic bool `protobuf:"varint,3,opt,name=suppress_mic,json=suppressMic,proto3" json:"suppress_mic,omitempty"`
	// If `true` the canvas application occupies the full screen and won't
	// have a header at the top. A toast message will also be displayed on the
	// loading screen that includes the Action's display name, the developer's
	// name, and instructions for exiting the Action. Default value: `false`.
	EnableFullScreen bool `protobuf:"varint,8,opt,name=enable_full_screen,json=enableFullScreen,proto3" json:"enable_full_screen,omitempty"`
	// contains filtered or unexported fields
}

Represents an Interactive Canvas response to be sent to the user. This can be used in conjunction with the "first_simple" field in the containing prompt to speak to the user in addition to displaying a interactive canvas response. The maximum size of the response is 50k bytes.

func (*Canvas) Descriptor deprecated

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

Deprecated: Use Canvas.ProtoReflect.Descriptor instead.

func (*Canvas) GetData

func (x *Canvas) GetData() []*structpb.Value

func (*Canvas) GetEnableFullScreen

func (x *Canvas) GetEnableFullScreen() bool

func (*Canvas) GetSuppressMic

func (x *Canvas) GetSuppressMic() bool

func (*Canvas) GetUrl

func (x *Canvas) GetUrl() string

func (*Canvas) ProtoMessage

func (*Canvas) ProtoMessage()

func (*Canvas) ProtoReflect

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

func (*Canvas) Reset

func (x *Canvas) Reset()

func (*Canvas) String

func (x *Canvas) String() string

type Card

type Card struct {

	// Overall title of the card.
	// Optional.
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	// Optional.
	Subtitle string `protobuf:"bytes,2,opt,name=subtitle,proto3" json:"subtitle,omitempty"`
	// Body text of the card.
	// Supports a limited set of markdown syntax for formatting.
	// Required, unless image is present.
	Text string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
	// A hero image for the card. The height is fixed to 192dp.
	// Optional.
	Image *Image `protobuf:"bytes,4,opt,name=image,proto3" json:"image,omitempty"`
	// How the image background will be filled. Optional.
	ImageFill Image_ImageFill `` /* 145-byte string literal not displayed */
	// Button.
	// Optional.
	Button *Link `protobuf:"bytes,6,opt,name=button,proto3" json:"button,omitempty"`
	// contains filtered or unexported fields
}

A basic card for displaying some information, e.g. an image and/or text.

func (*Card) Descriptor deprecated

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

Deprecated: Use Card.ProtoReflect.Descriptor instead.

func (*Card) GetButton

func (x *Card) GetButton() *Link

func (*Card) GetImage

func (x *Card) GetImage() *Image

func (*Card) GetImageFill

func (x *Card) GetImageFill() Image_ImageFill

func (*Card) GetSubtitle

func (x *Card) GetSubtitle() string

func (*Card) GetText

func (x *Card) GetText() string

func (*Card) GetTitle

func (x *Card) GetTitle() string

func (*Card) ProtoMessage

func (*Card) ProtoMessage()

func (*Card) ProtoReflect

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

func (*Card) Reset

func (x *Card) Reset()

func (*Card) String

func (x *Card) String() string

type Collection

type Collection struct {

	// Title of the collection. Optional.
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	// Subtitle of the collection. Optional.
	Subtitle string `protobuf:"bytes,2,opt,name=subtitle,proto3" json:"subtitle,omitempty"`
	// min: 2 max: 10
	Items []*Collection_CollectionItem `protobuf:"bytes,3,rep,name=items,proto3" json:"items,omitempty"`
	// How the image backgrounds of collection items will be filled. Optional.
	ImageFill Image_ImageFill `` /* 145-byte string literal not displayed */
	// contains filtered or unexported fields
}

A card for presenting a collection of options to select from.

func (*Collection) Descriptor deprecated

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

Deprecated: Use Collection.ProtoReflect.Descriptor instead.

func (*Collection) GetImageFill

func (x *Collection) GetImageFill() Image_ImageFill

func (*Collection) GetItems

func (x *Collection) GetItems() []*Collection_CollectionItem

func (*Collection) GetSubtitle

func (x *Collection) GetSubtitle() string

func (*Collection) GetTitle

func (x *Collection) GetTitle() string

func (*Collection) ProtoMessage

func (*Collection) ProtoMessage()

func (*Collection) ProtoReflect

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

func (*Collection) Reset

func (x *Collection) Reset()

func (*Collection) String

func (x *Collection) String() string

type Collection_CollectionItem

type Collection_CollectionItem struct {

	// Required. The NLU key that matches the entry key name in the associated
	// Type.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

An item in the collection

func (*Collection_CollectionItem) Descriptor deprecated

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

Deprecated: Use Collection_CollectionItem.ProtoReflect.Descriptor instead.

func (*Collection_CollectionItem) GetKey

func (x *Collection_CollectionItem) GetKey() string

func (*Collection_CollectionItem) ProtoMessage

func (*Collection_CollectionItem) ProtoMessage()

func (*Collection_CollectionItem) ProtoReflect

func (*Collection_CollectionItem) Reset

func (x *Collection_CollectionItem) Reset()

func (*Collection_CollectionItem) String

func (x *Collection_CollectionItem) String() string

type Content

type Content struct {

	// Content.
	//
	// Types that are assignable to Content:
	//
	//	*Content_Card
	//	*Content_Image
	//	*Content_Table
	//	*Content_Media
	//	*Content_Canvas
	//	*Content_Collection
	//	*Content_List
	Content isContent_Content `protobuf_oneof:"content"`
	// contains filtered or unexported fields
}

Content to be shown.

func (*Content) Descriptor deprecated

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

Deprecated: Use Content.ProtoReflect.Descriptor instead.

func (*Content) GetCanvas deprecated

func (x *Content) GetCanvas() *Canvas

Deprecated: Do not use.

func (*Content) GetCard

func (x *Content) GetCard() *Card

func (*Content) GetCollection

func (x *Content) GetCollection() *Collection

func (*Content) GetContent

func (m *Content) GetContent() isContent_Content

func (*Content) GetImage

func (x *Content) GetImage() *Image

func (*Content) GetList

func (x *Content) GetList() *List

func (*Content) GetMedia

func (x *Content) GetMedia() *Media

func (*Content) GetTable

func (x *Content) GetTable() *Table

func (*Content) ProtoMessage

func (*Content) ProtoMessage()

func (*Content) ProtoReflect

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

func (*Content) Reset

func (x *Content) Reset()

func (*Content) String

func (x *Content) String() string

type Content_Canvas

type Content_Canvas struct {
	// A response to be used for interactive canvas experience.
	//
	// Deprecated: Do not use.
	Canvas *Canvas `protobuf:"bytes,5,opt,name=canvas,proto3,oneof"`
}

type Content_Card

type Content_Card struct {
	// A basic card.
	Card *Card `protobuf:"bytes,1,opt,name=card,proto3,oneof"`
}

type Content_Collection

type Content_Collection struct {
	// A card presenting a collection of options to select from.
	Collection *Collection `protobuf:"bytes,6,opt,name=collection,proto3,oneof"`
}

type Content_Image

type Content_Image struct {
	// An image.
	Image *Image `protobuf:"bytes,2,opt,name=image,proto3,oneof"`
}

type Content_List

type Content_List struct {
	// A card presenting a list of options to select from.
	List *List `protobuf:"bytes,7,opt,name=list,proto3,oneof"`
}

type Content_Media

type Content_Media struct {
	// Response indicating a set of media to be played.
	Media *Media `protobuf:"bytes,4,opt,name=media,proto3,oneof"`
}

type Content_Table

type Content_Table struct {
	// Table card.
	Table *Table `protobuf:"bytes,3,opt,name=table,proto3,oneof"`
}

type Image

type Image struct {

	// The source url of the image. Images can be JPG, PNG and GIF (animated and
	// non-animated). For example,`https://www.agentx.com/logo.png`. Required.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// A text description of the image to be used for accessibility, e.g. screen
	// readers.
	// Required.
	Alt string `protobuf:"bytes,2,opt,name=alt,proto3" json:"alt,omitempty"`
	// The height of the image in pixels.
	// Optional.
	Height int32 `protobuf:"varint,3,opt,name=height,proto3" json:"height,omitempty"`
	// The width of the image in pixels.
	// Optional.
	Width int32 `protobuf:"varint,4,opt,name=width,proto3" json:"width,omitempty"`
	// contains filtered or unexported fields
}

An image displayed in the card.

func (*Image) Descriptor deprecated

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

Deprecated: Use Image.ProtoReflect.Descriptor instead.

func (*Image) GetAlt

func (x *Image) GetAlt() string

func (*Image) GetHeight

func (x *Image) GetHeight() int32

func (*Image) GetUrl

func (x *Image) GetUrl() string

func (*Image) GetWidth

func (x *Image) GetWidth() int32

func (*Image) ProtoMessage

func (*Image) ProtoMessage()

func (*Image) ProtoReflect

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

func (*Image) Reset

func (x *Image) Reset()

func (*Image) String

func (x *Image) String() string

type Image_ImageFill

type Image_ImageFill int32

Possible image display options for affecting the presentation of the image. This should be used for when the image's aspect ratio does not match the image container's aspect ratio.

const (
	// Unspecified image fill.
	Image_UNSPECIFIED Image_ImageFill = 0
	// Fill the gaps between the image and the image container with gray bars.
	Image_GRAY Image_ImageFill = 1
	// Fill the gaps between the image and the image container with white bars.
	Image_WHITE Image_ImageFill = 2
	// Image is scaled such that the image width and height match or exceed the
	// container dimensions. This may crop the top and bottom of the image if
	// the scaled image height is greater than the container height, or crop the
	// left and right of the image if the scaled image width is greater than the
	// container width. This is similar to "Zoom Mode" on a widescreen TV when
	// playing a 4:3 video.
	Image_CROPPED Image_ImageFill = 3
)

func (Image_ImageFill) Descriptor

func (Image_ImageFill) Enum

func (x Image_ImageFill) Enum() *Image_ImageFill

func (Image_ImageFill) EnumDescriptor deprecated

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

Deprecated: Use Image_ImageFill.Descriptor instead.

func (Image_ImageFill) Number

func (Image_ImageFill) String

func (x Image_ImageFill) String() string

func (Image_ImageFill) Type

type Intent

type Intent struct {

	// Required. The name of the last matched intent.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Represents parameters identified as part of intent matching.
	// This is a map of the name of the identified parameter to the value of the
	// parameter identified from user input. All parameters defined in
	// the matched intent that are identified will be surfaced here.
	Params map[string]*IntentParameterValue `` /* 153-byte string literal not displayed */
	// Optional. Typed or spoken input from the end user that matched this intent.
	// This will be populated when an intent is matched, based on the user input.
	Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
	// contains filtered or unexported fields
}

Represents an intent.

func (*Intent) Descriptor deprecated

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

Deprecated: Use Intent.ProtoReflect.Descriptor instead.

func (*Intent) GetName

func (x *Intent) GetName() string

func (*Intent) GetParams

func (x *Intent) GetParams() map[string]*IntentParameterValue

func (*Intent) GetQuery

func (x *Intent) GetQuery() 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 IntentParameterValue

type IntentParameterValue struct {

	// Required. Original text value extracted from user utterance.
	Original string `protobuf:"bytes,1,opt,name=original,proto3" json:"original,omitempty"`
	// Required. Structured value for parameter extracted from user input.
	// This will only be populated if the parameter is defined in the matched
	// intent and the value of the parameter could be identified during intent
	// matching.
	Resolved *structpb.Value `protobuf:"bytes,2,opt,name=resolved,proto3" json:"resolved,omitempty"`
	// contains filtered or unexported fields
}

Represents a value for intent parameter.

func (*IntentParameterValue) Descriptor deprecated

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

Deprecated: Use IntentParameterValue.ProtoReflect.Descriptor instead.

func (*IntentParameterValue) GetOriginal

func (x *IntentParameterValue) GetOriginal() string

func (*IntentParameterValue) GetResolved

func (x *IntentParameterValue) GetResolved() *structpb.Value

func (*IntentParameterValue) ProtoMessage

func (*IntentParameterValue) ProtoMessage()

func (*IntentParameterValue) ProtoReflect

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

func (*IntentParameterValue) Reset

func (x *IntentParameterValue) Reset()

func (*IntentParameterValue) String

func (x *IntentParameterValue) String() string
type Link struct {

	// Name of the link
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// What happens when a user opens the link
	Open *OpenUrl `protobuf:"bytes,2,opt,name=open,proto3" json:"open,omitempty"`
	// contains filtered or unexported fields
}

Link content.

func (*Link) Descriptor deprecated

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

Deprecated: Use Link.ProtoReflect.Descriptor instead.

func (*Link) GetName

func (x *Link) GetName() string

func (*Link) GetOpen

func (x *Link) GetOpen() *OpenUrl

func (*Link) ProtoMessage

func (*Link) ProtoMessage()

func (*Link) ProtoReflect

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

func (*Link) Reset

func (x *Link) Reset()

func (*Link) String

func (x *Link) String() string

type List

type List struct {

	// Title of the list. Optional.
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	// Subtitle of the list. Optional.
	Subtitle string `protobuf:"bytes,2,opt,name=subtitle,proto3" json:"subtitle,omitempty"`
	// min: 2 max: 30
	Items []*List_ListItem `protobuf:"bytes,3,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

A card for presenting a list of options to select from.

func (*List) Descriptor deprecated

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

Deprecated: Use List.ProtoReflect.Descriptor instead.

func (*List) GetItems

func (x *List) GetItems() []*List_ListItem

func (*List) GetSubtitle

func (x *List) GetSubtitle() string

func (*List) GetTitle

func (x *List) GetTitle() string

func (*List) ProtoMessage

func (*List) ProtoMessage()

func (*List) ProtoReflect

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

func (*List) Reset

func (x *List) Reset()

func (*List) String

func (x *List) String() string

type List_ListItem

type List_ListItem struct {

	// Required. The NLU key that matches the entry key name in the associated
	// Type.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

An item in the list

func (*List_ListItem) Descriptor deprecated

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

Deprecated: Use List_ListItem.ProtoReflect.Descriptor instead.

func (*List_ListItem) GetKey

func (x *List_ListItem) GetKey() string

func (*List_ListItem) ProtoMessage

func (*List_ListItem) ProtoMessage()

func (*List_ListItem) ProtoReflect

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

func (*List_ListItem) Reset

func (x *List_ListItem) Reset()

func (*List_ListItem) String

func (x *List_ListItem) String() string

type Media

type Media struct {

	// Media type.
	MediaType Media_MediaType `` /* 145-byte string literal not displayed */
	// Start offset of the first media object.
	StartOffset *durationpb.Duration `protobuf:"bytes,5,opt,name=start_offset,json=startOffset,proto3" json:"start_offset,omitempty"`
	// Optional media control types this media response session can support.
	// If set, request will be made to 3p when a certain media event happens.
	// If not set, 3p must still handle two default control type, FINISHED and
	// FAILED.
	OptionalMediaControls []Media_OptionalMediaControls `` /* 202-byte string literal not displayed */
	// List of Media Objects
	MediaObjects []*MediaObject `protobuf:"bytes,7,rep,name=media_objects,json=mediaObjects,proto3" json:"media_objects,omitempty"`
	// contains filtered or unexported fields
}

Represents one media object. Contains information about the media, such as name, description, url, etc.

func (*Media) Descriptor deprecated

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

Deprecated: Use Media.ProtoReflect.Descriptor instead.

func (*Media) GetMediaObjects

func (x *Media) GetMediaObjects() []*MediaObject

func (*Media) GetMediaType

func (x *Media) GetMediaType() Media_MediaType

func (*Media) GetOptionalMediaControls

func (x *Media) GetOptionalMediaControls() []Media_OptionalMediaControls

func (*Media) GetStartOffset

func (x *Media) GetStartOffset() *durationpb.Duration

func (*Media) ProtoMessage

func (*Media) ProtoMessage()

func (*Media) ProtoReflect

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

func (*Media) Reset

func (x *Media) Reset()

func (*Media) String

func (x *Media) String() string

type MediaImage

type MediaImage struct {

	// Image.
	//
	// Types that are assignable to Image:
	//
	//	*MediaImage_Large
	//	*MediaImage_Icon
	Image isMediaImage_Image `protobuf_oneof:"image"`
	// contains filtered or unexported fields
}

Image to show with the media card.

func (*MediaImage) Descriptor deprecated

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

Deprecated: Use MediaImage.ProtoReflect.Descriptor instead.

func (*MediaImage) GetIcon

func (x *MediaImage) GetIcon() *Image

func (*MediaImage) GetImage

func (m *MediaImage) GetImage() isMediaImage_Image

func (*MediaImage) GetLarge

func (x *MediaImage) GetLarge() *Image

func (*MediaImage) ProtoMessage

func (*MediaImage) ProtoMessage()

func (*MediaImage) ProtoReflect

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

func (*MediaImage) Reset

func (x *MediaImage) Reset()

func (*MediaImage) String

func (x *MediaImage) String() string

type MediaImage_Icon

type MediaImage_Icon struct {
	// A small image icon displayed on the right from the title.
	// It's resized to 36x36 dp.
	Icon *Image `protobuf:"bytes,2,opt,name=icon,proto3,oneof"`
}

type MediaImage_Large

type MediaImage_Large struct {
	// A large image, such as the cover of the album, etc.
	Large *Image `protobuf:"bytes,1,opt,name=large,proto3,oneof"`
}

type MediaObject

type MediaObject struct {

	// Name of this media object.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Description of this media object.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// The url pointing to the media content.
	Url string `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"`
	// Image to show with the media card.
	Image *MediaImage `protobuf:"bytes,4,opt,name=image,proto3" json:"image,omitempty"`
	// contains filtered or unexported fields
}

Represents a single media object

func (*MediaObject) Descriptor deprecated

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

Deprecated: Use MediaObject.ProtoReflect.Descriptor instead.

func (*MediaObject) GetDescription

func (x *MediaObject) GetDescription() string

func (*MediaObject) GetImage

func (x *MediaObject) GetImage() *MediaImage

func (*MediaObject) GetName

func (x *MediaObject) GetName() string

func (*MediaObject) GetUrl

func (x *MediaObject) GetUrl() string

func (*MediaObject) ProtoMessage

func (*MediaObject) ProtoMessage()

func (*MediaObject) ProtoReflect

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

func (*MediaObject) Reset

func (x *MediaObject) Reset()

func (*MediaObject) String

func (x *MediaObject) String() string

type Media_MediaType

type Media_MediaType int32

Media type of this response.

const (
	// Unspecified media type.
	Media_MEDIA_TYPE_UNSPECIFIED Media_MediaType = 0
	// Audio file.
	Media_AUDIO Media_MediaType = 1
	// Response to acknowledge a media status report.
	Media_MEDIA_STATUS_ACK Media_MediaType = 2
)

func (Media_MediaType) Descriptor

func (Media_MediaType) Enum

func (x Media_MediaType) Enum() *Media_MediaType

func (Media_MediaType) EnumDescriptor deprecated

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

Deprecated: Use Media_MediaType.Descriptor instead.

func (Media_MediaType) Number

func (Media_MediaType) String

func (x Media_MediaType) String() string

func (Media_MediaType) Type

type Media_OptionalMediaControls

type Media_OptionalMediaControls int32

Optional media control types the media response can support

const (
	// Unspecified value
	Media_OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED Media_OptionalMediaControls = 0
	// Paused event. Triggered when user pauses the media.
	Media_PAUSED Media_OptionalMediaControls = 1
	// Stopped event. Triggered when user exits out of 3p session during media
	// play.
	Media_STOPPED Media_OptionalMediaControls = 2
)

func (Media_OptionalMediaControls) Descriptor

func (Media_OptionalMediaControls) Enum

func (Media_OptionalMediaControls) EnumDescriptor deprecated

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

Deprecated: Use Media_OptionalMediaControls.Descriptor instead.

func (Media_OptionalMediaControls) Number

func (Media_OptionalMediaControls) String

func (Media_OptionalMediaControls) Type

type OpenUrl

type OpenUrl struct {

	// The url field which could be any of:
	// - http/https urls for opening an App-linked App or a webpage
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// Indicates a hint for the url type.
	Hint UrlHint `protobuf:"varint,2,opt,name=hint,proto3,enum=google.actions.sdk.v2.conversation.UrlHint" json:"hint,omitempty"`
	// contains filtered or unexported fields
}

Action taken when a user opens a link.

func (*OpenUrl) Descriptor deprecated

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

Deprecated: Use OpenUrl.ProtoReflect.Descriptor instead.

func (*OpenUrl) GetHint

func (x *OpenUrl) GetHint() UrlHint

func (*OpenUrl) GetUrl

func (x *OpenUrl) GetUrl() string

func (*OpenUrl) ProtoMessage

func (*OpenUrl) ProtoMessage()

func (*OpenUrl) ProtoReflect

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

func (*OpenUrl) Reset

func (x *OpenUrl) Reset()

func (*OpenUrl) String

func (x *OpenUrl) String() string

type Prompt

type Prompt struct {

	// Optional. Mode for how this messages should be merged with previously
	// defined messages.
	// "false" will clear all previously defined messages (first and last
	// simple, content, suggestions link and canvas) and add messages defined in
	// this prompt.
	// "true" will add messages defined in this prompt to messages defined in
	// previous responses. Setting this field to "true" will also enable appending
	// to some fields inside Simple prompts, the Suggestion prompt and the Canvas
	// prompt (part of the Content prompt). The Content and Link messages will
	// always be overwritten if defined in the prompt.
	// Default value is "false".
	//
	// Deprecated: Do not use.
	Append bool `protobuf:"varint,1,opt,name=append,proto3" json:"append,omitempty"`
	// Optional. Mode for how this messages should be merged with previously
	// defined messages.
	// "true" clears all previously defined messages (first and last
	// simple, content, suggestions link and canvas) and adds messages defined in
	// this prompt.
	// "false" adds messages defined in this prompt to messages defined in
	// previous responses. Leaving this field to "false" also enables
	// appending to some fields inside Simple prompts, the Suggestions prompt,
	// and the Canvas prompt (part of the Content prompt). The Content and Link
	// messages are always overwritten if defined in the prompt. Default
	// value is "false".
	Override bool `protobuf:"varint,8,opt,name=override,proto3" json:"override,omitempty"`
	// Optional. The first voice and text-only response.
	FirstSimple *Simple `protobuf:"bytes,2,opt,name=first_simple,json=firstSimple,proto3" json:"first_simple,omitempty"`
	// Optional. A content like a card, list or media to display to the user.
	Content *Content `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// Optional. The last voice and text-only response.
	LastSimple *Simple `protobuf:"bytes,4,opt,name=last_simple,json=lastSimple,proto3" json:"last_simple,omitempty"`
	// Optional. Suggestions to be displayed to the user which will always appear
	// at the end of the response.
	// If the "override" field in the containing prompt is "false", the titles
	// defined in this field will be added to titles defined in any previously
	// defined suggestions prompts and duplicate values will be removed.
	Suggestions []*Suggestion `protobuf:"bytes,5,rep,name=suggestions,proto3" json:"suggestions,omitempty"`
	// Optional. An additional suggestion chip that can link out to the associated app
	// or site.
	// The chip will be rendered with the title "Open <name>". Max 20 chars.
	Link *Link `protobuf:"bytes,6,opt,name=link,proto3" json:"link,omitempty"`
	// Optional. Represents a Interactive Canvas response to be sent to the user.
	Canvas *Canvas `protobuf:"bytes,9,opt,name=canvas,proto3" json:"canvas,omitempty"`
	// contains filtered or unexported fields
}

Represent a response to a user.

func (*Prompt) Descriptor deprecated

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

Deprecated: Use Prompt.ProtoReflect.Descriptor instead.

func (*Prompt) GetAppend deprecated

func (x *Prompt) GetAppend() bool

Deprecated: Do not use.

func (*Prompt) GetCanvas

func (x *Prompt) GetCanvas() *Canvas

func (*Prompt) GetContent

func (x *Prompt) GetContent() *Content

func (*Prompt) GetFirstSimple

func (x *Prompt) GetFirstSimple() *Simple

func (*Prompt) GetLastSimple

func (x *Prompt) GetLastSimple() *Simple
func (x *Prompt) GetLink() *Link

func (*Prompt) GetOverride

func (x *Prompt) GetOverride() bool

func (*Prompt) GetSuggestions

func (x *Prompt) GetSuggestions() []*Suggestion

func (*Prompt) ProtoMessage

func (*Prompt) ProtoMessage()

func (*Prompt) ProtoReflect

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

func (*Prompt) Reset

func (x *Prompt) Reset()

func (*Prompt) String

func (x *Prompt) String() string

type Simple

type Simple struct {

	// Optional. Represents the speech to be spoken to the user. Can be SSML or
	// text to speech.
	// If the "override" field in the containing prompt is "true", the speech
	// defined in this field replaces the previous Simple prompt's speech.
	Speech string `protobuf:"bytes,1,opt,name=speech,proto3" json:"speech,omitempty"`
	// Optional text to display in the chat bubble. If not given, a display
	// rendering of the speech field above will be used. Limited to 640
	// chars.
	// If the "override" field in the containing prompt is "true", the text
	// defined in this field replaces to the previous Simple prompt's text.
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

Represents a simple prompt to be send to a user.

func (*Simple) Descriptor deprecated

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

Deprecated: Use Simple.ProtoReflect.Descriptor instead.

func (*Simple) GetSpeech

func (x *Simple) GetSpeech() string

func (*Simple) GetText

func (x *Simple) GetText() string

func (*Simple) ProtoMessage

func (*Simple) ProtoMessage()

func (*Simple) ProtoReflect

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

func (*Simple) Reset

func (x *Simple) Reset()

func (*Simple) String

func (x *Simple) String() string

type Slot

type Slot struct {

	// The mode of the slot (required or optional). Can be set by developer.
	Mode Slot_SlotMode `protobuf:"varint,1,opt,name=mode,proto3,enum=google.actions.sdk.v2.conversation.Slot_SlotMode" json:"mode,omitempty"`
	// The status of the slot.
	Status Slot_SlotStatus `protobuf:"varint,2,opt,name=status,proto3,enum=google.actions.sdk.v2.conversation.Slot_SlotStatus" json:"status,omitempty"`
	// The value of the slot. Changing this value in the response, will
	// modify the value in slot filling.
	Value *structpb.Value `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// Indicates if the slot value was collected on the last turn.
	// This field is read-only.
	Updated bool `protobuf:"varint,4,opt,name=updated,proto3" json:"updated,omitempty"`
	// Optional. This prompt is sent to the user when needed to fill a required
	// slot. This prompt overrides the existing prompt defined in the console.
	// This field is not included in the webhook request.
	Prompt *Prompt `protobuf:"bytes,5,opt,name=prompt,proto3" json:"prompt,omitempty"`
	// contains filtered or unexported fields
}

Represents a slot.

func (*Slot) Descriptor deprecated

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

Deprecated: Use Slot.ProtoReflect.Descriptor instead.

func (*Slot) GetMode

func (x *Slot) GetMode() Slot_SlotMode

func (*Slot) GetPrompt

func (x *Slot) GetPrompt() *Prompt

func (*Slot) GetStatus

func (x *Slot) GetStatus() Slot_SlotStatus

func (*Slot) GetUpdated

func (x *Slot) GetUpdated() bool

func (*Slot) GetValue

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

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 SlotFillingStatus

type SlotFillingStatus int32

Represents the current status of slot filling.

const (
	// Fallback value when the usage field is not populated.
	SlotFillingStatus_UNSPECIFIED SlotFillingStatus = 0
	// The slots have been initialized but slot filling has not started.
	SlotFillingStatus_INITIALIZED SlotFillingStatus = 1
	// The slot values are being collected.
	SlotFillingStatus_COLLECTING SlotFillingStatus = 2
	// All slot values are final and cannot be changed.
	SlotFillingStatus_FINAL SlotFillingStatus = 4
)

func (SlotFillingStatus) Descriptor

func (SlotFillingStatus) Enum

func (SlotFillingStatus) EnumDescriptor deprecated

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

Deprecated: Use SlotFillingStatus.Descriptor instead.

func (SlotFillingStatus) Number

func (SlotFillingStatus) String

func (x SlotFillingStatus) String() string

func (SlotFillingStatus) Type

type Slot_SlotMode

type Slot_SlotMode int32

Represents the mode of a slot, that is, if it is required or not.

const (
	// Fallback value when the usage field is not populated.
	Slot_MODE_UNSPECIFIED Slot_SlotMode = 0
	// Indicates that the slot is not required to complete slot filling.
	Slot_OPTIONAL Slot_SlotMode = 1
	// Indicates that the slot is required to complete slot filling.
	Slot_REQUIRED Slot_SlotMode = 2
)

func (Slot_SlotMode) Descriptor

func (Slot_SlotMode) Enum

func (x Slot_SlotMode) Enum() *Slot_SlotMode

func (Slot_SlotMode) EnumDescriptor deprecated

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

Deprecated: Use Slot_SlotMode.Descriptor instead.

func (Slot_SlotMode) Number

func (Slot_SlotMode) String

func (x Slot_SlotMode) String() string

func (Slot_SlotMode) Type

type Slot_SlotStatus

type Slot_SlotStatus int32

Represents the status of a slot.

const (
	// Fallback value when the usage field is not populated.
	Slot_SLOT_UNSPECIFIED Slot_SlotStatus = 0
	// Indicates that the slot does not have any values. This status cannot be
	// modified through the response.
	Slot_EMPTY Slot_SlotStatus = 1
	// Indicates that the slot value is invalid. This status can be set
	// through the response.
	Slot_INVALID Slot_SlotStatus = 2
	// Indicates that the slot has a value. This status cannot be modified
	// through the response.
	Slot_FILLED Slot_SlotStatus = 3
)

func (Slot_SlotStatus) Descriptor

func (Slot_SlotStatus) Enum

func (x Slot_SlotStatus) Enum() *Slot_SlotStatus

func (Slot_SlotStatus) EnumDescriptor deprecated

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

Deprecated: Use Slot_SlotStatus.Descriptor instead.

func (Slot_SlotStatus) Number

func (Slot_SlotStatus) String

func (x Slot_SlotStatus) String() string

func (Slot_SlotStatus) Type

type Suggestion

type Suggestion struct {

	// Required. The text shown in the suggestion chip. When tapped, this text will be
	// posted back to the conversation verbatim as if the user had typed it.
	// Each title must be unique among the set of suggestion chips.
	// Max 25 chars
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	// contains filtered or unexported fields
}

Input suggestion to be presented to the user.

func (*Suggestion) Descriptor deprecated

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

Deprecated: Use Suggestion.ProtoReflect.Descriptor instead.

func (*Suggestion) GetTitle

func (x *Suggestion) GetTitle() string

func (*Suggestion) ProtoMessage

func (*Suggestion) ProtoMessage()

func (*Suggestion) ProtoReflect

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

func (*Suggestion) Reset

func (x *Suggestion) Reset()

func (*Suggestion) String

func (x *Suggestion) String() string

type Table

type Table struct {

	// Overall title of the table. Optional but must be set if subtitle is set.
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	// Subtitle for the table. Optional.
	Subtitle string `protobuf:"bytes,2,opt,name=subtitle,proto3" json:"subtitle,omitempty"`
	// Image associated with the table. Optional.
	Image *Image `protobuf:"bytes,4,opt,name=image,proto3" json:"image,omitempty"`
	// Headers and alignment of columns.
	Columns []*TableColumn `protobuf:"bytes,5,rep,name=columns,proto3" json:"columns,omitempty"`
	// Row data of the table. The first 3 rows are guaranteed to be shown but
	// others might be cut on certain surfaces. Please test with the simulator to
	// see which rows will be shown for a given surface. On surfaces that support
	// the WEB_BROWSER capability, you can point the user to
	// a web page with more data.
	Rows []*TableRow `protobuf:"bytes,6,rep,name=rows,proto3" json:"rows,omitempty"`
	// Button.
	Button *Link `protobuf:"bytes,7,opt,name=button,proto3" json:"button,omitempty"`
	// contains filtered or unexported fields
}

A table card for displaying a table of text.

func (*Table) Descriptor deprecated

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

Deprecated: Use Table.ProtoReflect.Descriptor instead.

func (*Table) GetButton

func (x *Table) GetButton() *Link

func (*Table) GetColumns

func (x *Table) GetColumns() []*TableColumn

func (*Table) GetImage

func (x *Table) GetImage() *Image

func (*Table) GetRows

func (x *Table) GetRows() []*TableRow

func (*Table) GetSubtitle

func (x *Table) GetSubtitle() string

func (*Table) GetTitle

func (x *Table) GetTitle() string

func (*Table) ProtoMessage

func (*Table) ProtoMessage()

func (*Table) ProtoReflect

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

func (*Table) Reset

func (x *Table) Reset()

func (*Table) String

func (x *Table) String() string

type TableCell

type TableCell struct {

	// Text content of the cell.
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

Describes a cell in a row.

func (*TableCell) Descriptor deprecated

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

Deprecated: Use TableCell.ProtoReflect.Descriptor instead.

func (*TableCell) GetText

func (x *TableCell) GetText() string

func (*TableCell) ProtoMessage

func (*TableCell) ProtoMessage()

func (*TableCell) ProtoReflect

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

func (*TableCell) Reset

func (x *TableCell) Reset()

func (*TableCell) String

func (x *TableCell) String() string

type TableColumn

type TableColumn struct {

	// Header text for the column.
	Header string `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Horizontal alignment of content w.r.t column. If unspecified, content
	// will be aligned to the leading edge.
	Align TableColumn_HorizontalAlignment `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes a column in a table.

func (*TableColumn) Descriptor deprecated

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

Deprecated: Use TableColumn.ProtoReflect.Descriptor instead.

func (*TableColumn) GetAlign

func (*TableColumn) GetHeader

func (x *TableColumn) GetHeader() string

func (*TableColumn) ProtoMessage

func (*TableColumn) ProtoMessage()

func (*TableColumn) ProtoReflect

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

func (*TableColumn) Reset

func (x *TableColumn) Reset()

func (*TableColumn) String

func (x *TableColumn) String() string

type TableColumn_HorizontalAlignment

type TableColumn_HorizontalAlignment int32

The alignment of the content within the cell.

const (
	// Unspecified horizontal alignment.
	TableColumn_UNSPECIFIED TableColumn_HorizontalAlignment = 0
	// Leading edge of the cell. This is the default.
	TableColumn_LEADING TableColumn_HorizontalAlignment = 1
	// Content is aligned to the center of the column.
	TableColumn_CENTER TableColumn_HorizontalAlignment = 2
	// Content is aligned to the trailing edge of the column.
	TableColumn_TRAILING TableColumn_HorizontalAlignment = 3
)

func (TableColumn_HorizontalAlignment) Descriptor

func (TableColumn_HorizontalAlignment) Enum

func (TableColumn_HorizontalAlignment) EnumDescriptor deprecated

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

Deprecated: Use TableColumn_HorizontalAlignment.Descriptor instead.

func (TableColumn_HorizontalAlignment) Number

func (TableColumn_HorizontalAlignment) String

func (TableColumn_HorizontalAlignment) Type

type TableRow

type TableRow struct {

	// Cells in this row. The first 3 cells are guaranteed to be shown but
	// others might be cut on certain surfaces. Please test with the simulator
	// to see which cells will be shown for a given surface.
	Cells []*TableCell `protobuf:"bytes,1,rep,name=cells,proto3" json:"cells,omitempty"`
	// Indicates whether there should be a divider after each row.
	Divider bool `protobuf:"varint,2,opt,name=divider,proto3" json:"divider,omitempty"`
	// contains filtered or unexported fields
}

Describes a row in the table.

func (*TableRow) Descriptor deprecated

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

Deprecated: Use TableRow.ProtoReflect.Descriptor instead.

func (*TableRow) GetCells

func (x *TableRow) GetCells() []*TableCell

func (*TableRow) GetDivider

func (x *TableRow) GetDivider() bool

func (*TableRow) ProtoMessage

func (*TableRow) ProtoMessage()

func (*TableRow) ProtoReflect

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

func (*TableRow) Reset

func (x *TableRow) Reset()

func (*TableRow) String

func (x *TableRow) String() string

type UrlHint

type UrlHint int32

Different types of url hints.

const (
	// Unspecified
	UrlHint_LINK_UNSPECIFIED UrlHint = 0
	// URL that points directly to AMP content, or to a canonical URL
	// which refers to AMP content via <link rel="amphtml">.
	UrlHint_AMP UrlHint = 1
)

func (UrlHint) Descriptor

func (UrlHint) Descriptor() protoreflect.EnumDescriptor

func (UrlHint) Enum

func (x UrlHint) Enum() *UrlHint

func (UrlHint) EnumDescriptor deprecated

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

Deprecated: Use UrlHint.Descriptor instead.

func (UrlHint) Number

func (x UrlHint) Number() protoreflect.EnumNumber

func (UrlHint) String

func (x UrlHint) String() string

func (UrlHint) Type

func (UrlHint) Type() protoreflect.EnumType

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL