Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Playbook (v1.11.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Playbook.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#code_block

def code_block() -> ::Google::Cloud::Dialogflow::CX::V3::CodeBlock
Returns

#code_block=

def code_block=(value) -> ::Google::Cloud::Dialogflow::CX::V3::CodeBlock
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The human-readable name of the playbook, unique within an agent.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The human-readable name of the playbook, unique within an agent.
Returns
  • (::String) — Required. The human-readable name of the playbook, unique within an agent.

#goal

def goal() -> ::String
Returns
  • (::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.

#goal=

def goal=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#handlers

def handlers() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Handler>
Returns

#handlers=

def handlers=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Handler>
Parameter
Returns

#inline_actions

def inline_actions() -> ::Array<::String>
Returns
  • (::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.

#input_parameter_definitions

def input_parameter_definitions() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::ParameterDefinition>
Returns

#input_parameter_definitions=

def input_parameter_definitions=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::ParameterDefinition>
Parameter
Returns

#instruction

def instruction() -> ::Google::Cloud::Dialogflow::CX::V3::Playbook::Instruction
Returns

#instruction=

def instruction=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Playbook::Instruction
Parameter
Returns

#llm_model_settings

def llm_model_settings() -> ::Google::Cloud::Dialogflow::CX::V3::LlmModelSettings
Returns

#llm_model_settings=

def llm_model_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::LlmModelSettings
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — The unique identifier of the playbook. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The unique identifier of the playbook. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.
Returns
  • (::String) — The unique identifier of the playbook. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

#output_parameter_definitions

def output_parameter_definitions() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::ParameterDefinition>
Returns

#output_parameter_definitions=

def output_parameter_definitions=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::ParameterDefinition>
Parameter
Returns

#playbook_type

def playbook_type() -> ::Google::Cloud::Dialogflow::CX::V3::Playbook::PlaybookType
Returns

#playbook_type=

def playbook_type=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Playbook::PlaybookType
Parameter
Returns

#referenced_flows

def referenced_flows() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. The resource name of flows referenced by the current playbook in the instructions.

#referenced_playbooks

def referenced_playbooks() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. The resource name of other playbooks referenced by the current playbook in the instructions.

#referenced_tools

def referenced_tools() -> ::Array<::String>
Returns
  • (::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.

#referenced_tools=

def referenced_tools=(value) -> ::Array<::String>
Parameter
  • value (::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.
Returns
  • (::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.

#token_count

def token_count() -> ::Integer
Returns
  • (::Integer) — Output only. Estimated number of tokes current playbook takes when sent to the LLM.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns