Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion

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

Overview

Playbook version is a snapshot of the playbook at certain timestamp.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1PlaybookVersion

Returns a new instance of GoogleCloudDialogflowCxV3beta1PlaybookVersion.



10724
10725
10726
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10724

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

Instance Attribute Details

#description ⇒ String

Optional. The description of the playbook version. Corresponds to the JSON property description

Returns:

  • (String) 


10695
10696
10697
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10695

def description
  @description
end

#examples ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example>

Output only. Snapshot of the examples belonging to the playbook when the playbook version is created. Corresponds to the JSON property examples

Returns:



10701
10702
10703
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10701

def examples
  @examples
end

#name ⇒ String

The unique identifier of the playbook version. Format: projects//locations// agents//playbooks//versions/. Corresponds to the JSON property name

Returns:

  • (String) 


10707
10708
10709
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10707

def name
  @name
end

#playbook ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook

Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. Corresponds to the JSON property playbook

Returns:



10717
10718
10719
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10717

def playbook
  @playbook
end

#update_time ⇒ String

Output only. Last time the playbook version was created or modified. Corresponds to the JSON property updateTime

Returns:

  • (String) 


10722
10723
10724
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10722

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10729
10730
10731
10732
10733
10734
10735
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10729

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @examples = args[:examples] if args.key?(:examples)
  @name = args[:name] if args.key?(:name)
  @playbook = args[:playbook] if args.key?(:playbook)
  @update_time = args[:update_time] if args.key?(:update_time)
end