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.



9594
9595
9596
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9594

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) 


9526
9527
9528
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9526

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) 


9531
9532
9533
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9531

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) 


9536
9537
9538
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9536

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:



9541
9542
9543
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9541

def input_parameter_definitions
  @input_parameter_definitions
end

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

Settings for LLM models. Corresponds to the JSON property llmModelSettings

Returns:



9546
9547
9548
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9546

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) 


9552
9553
9554
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9552

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:



9557
9558
9559
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9557

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


9563
9564
9565
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9563

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


9569
9570
9571
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9569

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


9576
9577
9578
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9576

def referenced_tools
  @referenced_tools
end

#steps ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookStep>

Ordered list of step by step execution instructions to accomplish target goal. Corresponds to the JSON property steps

Returns:



9581
9582
9583
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9581

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


9587
9588
9589
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9587

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) 


9592
9593
9594
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9592

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9599

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)
  @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)
  @steps = args[:steps] if args.key?(:steps)
  @token_count = args[:token_count] if args.key?(:token_count)
  @update_time = args[:update_time] if args.key?(:update_time)
end