Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::WidgetTool.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#data_mapping
def data_mapping() -> ::Google::Cloud::Ces::V1beta::WidgetTool::DataMapping
Returns
- (::Google::Cloud::Ces::V1beta::WidgetTool::DataMapping) — Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.
#data_mapping=
def data_mapping=(value) -> ::Google::Cloud::Ces::V1beta::WidgetTool::DataMapping
Parameter
- value (::Google::Cloud::Ces::V1beta::WidgetTool::DataMapping) — Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.
Returns
- (::Google::Cloud::Ces::V1beta::WidgetTool::DataMapping) — Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.
#description
def description() -> ::String
Returns
- (::String) — Optional. The description of the widget tool.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. The description of the widget tool.
Returns
- (::String) — Optional. The description of the widget tool.
#name
def name() -> ::String
Returns
- (::String) — Required. The display name of the widget tool.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Required. The display name of the widget tool.
Returns
- (::String) — Required. The display name of the widget tool.
#parameters
def parameters() -> ::Google::Cloud::Ces::V1beta::Schema
Returns
- (::Google::Cloud::Ces::V1beta::Schema) — Optional. The input parameters of the widget tool.
#parameters=
def parameters=(value) -> ::Google::Cloud::Ces::V1beta::Schema
Parameter
- value (::Google::Cloud::Ces::V1beta::Schema) — Optional. The input parameters of the widget tool.
Returns
- (::Google::Cloud::Ces::V1beta::Schema) — Optional. The input parameters of the widget tool.
#ui_config
def ui_config() -> ::Google::Protobuf::Struct
Returns
- (::Google::Protobuf::Struct) — Optional. Configuration for rendering the widget.
#ui_config=
def ui_config=(value) -> ::Google::Protobuf::Struct
Parameter
- value (::Google::Protobuf::Struct) — Optional. Configuration for rendering the widget.
Returns
- (::Google::Protobuf::Struct) — Optional. Configuration for rendering the widget.
#widget_type
def widget_type() -> ::Google::Cloud::Ces::V1beta::WidgetTool::WidgetType
Returns
- (::Google::Cloud::Ces::V1beta::WidgetTool::WidgetType) — Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
#widget_type=
def widget_type=(value) -> ::Google::Cloud::Ces::V1beta::WidgetTool::WidgetType
Parameter
- value (::Google::Cloud::Ces::V1beta::WidgetTool::WidgetType) — Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
Returns
- (::Google::Cloud::Ces::V1beta::WidgetTool::WidgetType) — Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.