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.



9766
9767
9768
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9766

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

Instance Attribute Details

#descriptionString

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

Returns:

  • (String)


9737
9738
9739
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9737

def description
  @description
end

#examplesArray<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



9743
9744
9745
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9743

def examples
  @examples
end

#nameString

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

Returns:

  • (String)


9749
9750
9751
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9749

def name
  @name
end

#playbookGoogle::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



9759
9760
9761
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9759

def playbook
  @playbook
end

#update_timeString

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

Returns:

  • (String)


9764
9765
9766
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9764

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9771
9772
9773
9774
9775
9776
9777
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9771

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