Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1Playbook

Returns a new instance of GoogleCloudDialogflowCxV3beta1Playbook.



10711
10712
10713
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10711

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

Instance Attribute Details

#create_time ⇒ String

Output only. The timestamp of initial playbook creation. Corresponds to the JSON property createTime

Returns:

  • (String) 


10638
10639
10640
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10638

def create_time
  @create_time
end

#display_name ⇒ String

Required. The human-readable name of the playbook, unique within an agent. Corresponds to the JSON property displayName

Returns:

  • (String) 


10643
10644
10645
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10643

def display_name
  @display_name
end

#goal ⇒ String

Required. High level description of the goal the playbook intend to accomplish. Corresponds to the JSON property goal

Returns:

  • (String) 


10648
10649
10650
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10648

def goal
  @goal
end

#input_parameter_definitions ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ParameterDefinition>

Optional. Defined structured input parameters for this playbook. Corresponds to the JSON property inputParameterDefinitions

Returns:



10653
10654
10655
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10653

def input_parameter_definitions
  @input_parameter_definitions
end

#instruction ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookInstruction

Message of the Instruction of the playbook. Corresponds to the JSON property instruction

Returns:



10658
10659
10660
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10658

def instruction
  @instruction
end

#llm_model_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LlmModelSettings

Settings for LLM models. Corresponds to the JSON property llmModelSettings

Returns:



10663
10664
10665
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10663

def llm_model_settings
  @llm_model_settings
end

#name ⇒ String

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

Returns:

  • (String) 


10669
10670
10671
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10669

def name
  @name
end

#output_parameter_definitions ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ParameterDefinition>

Optional. Defined structured output parameters for this playbook. Corresponds to the JSON property outputParameterDefinitions

Returns:



10674
10675
10676
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10674

def output_parameter_definitions
  @output_parameter_definitions
end

#referenced_flows ⇒ Array<String>

Output only. The resource name of flows referenced by the current playbook in the instructions. Corresponds to the JSON property referencedFlows

Returns:

  • (Array<String>) 


10680
10681
10682
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10680

def referenced_flows
  @referenced_flows
end

#referenced_playbooks ⇒ Array<String>

Output only. The resource name of other playbooks referenced by the current playbook in the instructions. Corresponds to the JSON property referencedPlaybooks

Returns:

  • (Array<String>) 


10686
10687
10688
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10686

def referenced_playbooks
  @referenced_playbooks
end

#referenced_tools ⇒ Array<String>

Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps. Corresponds to the JSON property referencedTools

Returns:

  • (Array<String>) 


10693
10694
10695
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10693

def referenced_tools
  @referenced_tools
end

#speech_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings

Define behaviors of speech to text detection. Corresponds to the JSON property speechSettings

Returns:



10698
10699
10700
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10698

def speech_settings
  @speech_settings
end

#token_count ⇒ Fixnum

Output only. Estimated number of tokes current playbook takes when sent to the LLM. Corresponds to the JSON property tokenCount

Returns:

  • (Fixnum) 


10704
10705
10706
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10704

def token_count
  @token_count
end

#update_time ⇒ String

Output only. Last time the playbook version was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


10709
10710
10711
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10709

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10716

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @goal = args[:goal] if args.key?(:goal)
  @input_parameter_definitions = args[:input_parameter_definitions] if args.key?(:input_parameter_definitions)
  @instruction = args[:instruction] if args.key?(:instruction)
  @llm_model_settings = args[:llm_model_settings] if args.key?(:llm_model_settings)
  @name = args[:name] if args.key?(:name)
  @output_parameter_definitions = args[:output_parameter_definitions] if args.key?(:output_parameter_definitions)
  @referenced_flows = args[:referenced_flows] if args.key?(:referenced_flows)
  @referenced_playbooks = args[:referenced_playbooks] if args.key?(:referenced_playbooks)
  @referenced_tools = args[:referenced_tools] if args.key?(:referenced_tools)
  @speech_settings = args[:speech_settings] if args.key?(:speech_settings)
  @token_count = args[:token_count] if args.key?(:token_count)
  @update_time = args[:update_time] if args.key?(:update_time)
end