Class: Google::Apis::CesV1::WidgetTool

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/ces_v1/classes.rb,
lib/google/apis/ces_v1/representations.rb,
lib/google/apis/ces_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WidgetTool

Returns a new instance of WidgetTool.



8717
8718
8719
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8717

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#data_mapping ⇒ Google::Apis::CesV1::WidgetToolDataMapping

Configuration for mapping data from a source tool to the widget's input parameters. Corresponds to the JSON property dataMapping

Returns:



8684
8685
8686
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8684

def data_mapping
  @data_mapping
end

#description ⇒ String

Optional. The description of the widget tool. Corresponds to the JSON property description

Returns:

  • (String) 


8689
8690
8691
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8689

def description
  @description
end

#name ⇒ String

Required. The display name of the widget tool. Corresponds to the JSON property name

Returns:

  • (String) 


8694
8695
8696
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8694

def name
  @name
end

#parameters ⇒ Google::Apis::CesV1::Schema

Represents a select subset of an OpenAPI 3.0 schema object. Corresponds to the JSON property parameters

Returns:



8699
8700
8701
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8699

def parameters
  @parameters
end

#text_response_config ⇒ Google::Apis::CesV1::WidgetToolTextResponseConfig

Configuration for the text response returned with the widget. Corresponds to the JSON property textResponseConfig

Returns:



8704
8705
8706
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8704

def text_response_config
  @text_response_config
end

#ui_config ⇒ Hash<String,Object>

Optional. Configuration for rendering the widget. Corresponds to the JSON property uiConfig

Returns:

  • (Hash<String,Object>) 


8709
8710
8711
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8709

def ui_config
  @ui_config
end

#widget_type ⇒ String

Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. Corresponds to the JSON property widgetType

Returns:

  • (String) 


8715
8716
8717
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8715

def widget_type
  @widget_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8722
8723
8724
8725
8726
8727
8728
8729
8730
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8722

def update!(**args)
  @data_mapping = args[:data_mapping] if args.key?(:data_mapping)
  @description = args[:description] if args.key?(:description)
  @name = args[:name] if args.key?(:name)
  @parameters = args[:parameters] if args.key?(:parameters)
  @text_response_config = args[:text_response_config] if args.key?(:text_response_config)
  @ui_config = args[:ui_config] if args.key?(:ui_config)
  @widget_type = args[:widget_type] if args.key?(:widget_type)
end