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.



11772
11773
11774
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11772

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

Instance Attribute Details

#code_block ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CodeBlock

Represents a code block. Corresponds to the JSON property codeBlock

Returns:



11673
11674
11675
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11673

def code_block
  @code_block
end

#create_time ⇒ String

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

Returns:

  • (String) 


11678
11679
11680
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11678

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) 


11683
11684
11685
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11683

def display_name
  @display_name
end

#goal ⇒ String

Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. Corresponds to the JSON property goal

Returns:

  • (String) 


11690
11691
11692
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11690

def goal
  @goal
end

#handlers ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Handler>

Optional. A list of registered handlers to execute based on the specified triggers. Corresponds to the JSON property handlers

Returns:



11696
11697
11698
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11696

def handlers
  @handlers
end

#inline_actions ⇒ Array<String>

Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block. Corresponds to the JSON property inlineActions

Returns:

  • (Array<String>) 


11704
11705
11706
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11704

def inline_actions
  @inline_actions
end

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

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

Returns:



11709
11710
11711
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11709

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:



11714
11715
11716
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11714

def instruction
  @instruction
end

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

Settings for LLM models. Corresponds to the JSON property llmModelSettings

Returns:



11719
11720
11721
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11719

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) 


11725
11726
11727
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11725

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:



11730
11731
11732
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11730

def output_parameter_definitions
  @output_parameter_definitions
end

#playbook_type ⇒ String

Optional. Type of the playbook. Corresponds to the JSON property playbookType

Returns:

  • (String) 


11735
11736
11737
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11735

def playbook_type
  @playbook_type
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>) 


11741
11742
11743
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11741

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


11747
11748
11749
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11747

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


11754
11755
11756
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11754

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:



11759
11760
11761
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11759

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) 


11765
11766
11767
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11765

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) 


11770
11771
11772
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11770

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11777

def update!(**args)
  @code_block = args[:code_block] if args.key?(:code_block)
  @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)
  @handlers = args[:handlers] if args.key?(:handlers)
  @inline_actions = args[:inline_actions] if args.key?(:inline_actions)
  @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)
  @playbook_type = args[:playbook_type] if args.key?(:playbook_type)
  @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