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.



8701
8702
8703
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8701

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:



8668
8669
8670
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8668

def data_mapping
  @data_mapping
end

#description ⇒ String

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

Returns:

  • (String) 


8673
8674
8675
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8673

def description
  @description
end

#name ⇒ String

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

Returns:

  • (String) 


8678
8679
8680
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8678

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:



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

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:



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

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>) 


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

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) 


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

def widget_type
  @widget_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8706
8707
8708
8709
8710
8711
8712
8713
8714
 
# File 'lib/google/apis/ces_v1/classes.rb', line 8706

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