WidgetTool(mapping=None, *, ignore_unknown_fields=False, **kwargs)Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
parameters |
google.cloud.ces_v1beta.types.Schema
Optional. The input parameters of the widget tool. This field is a member of oneof_ input.
|
name |
str
Required. The display name of the widget tool. |
description |
str
Optional. The description of the widget tool. |
widget_type |
google.cloud.ces_v1beta.types.WidgetTool.WidgetType
Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. |
ui_config |
google.protobuf.struct_pb2.Struct
Optional. Configuration for rendering the widget. |
data_mapping |
google.cloud.ces_v1beta.types.WidgetTool.DataMapping
Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. |
Classes
DataMapping
DataMapping(mapping=None, *, ignore_unknown_fields=False, **kwargs)Configuration for mapping data from a source tool to the widget's input parameters.
WidgetType
WidgetType(value)All available widget types. New values may be added to this enum in the future.