Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class 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.
Generated from protobuf message google.cloud.dialogflow.cx.v3.Playbook
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique identifier of the playbook. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>
.
↳ display_name
string
Required. The human-readable name of the playbook, unique within an agent.
↳ 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.
↳ input_parameter_definitions
↳ output_parameter_definitions
↳ instruction
↳ token_count
int|string
Output only. Estimated number of tokes current playbook takes when sent to the LLM.
↳ create_time
↳ update_time
↳ referenced_playbooks
string[]
Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
↳ referenced_flows
string[]
Output only. The resource name of flows referenced by the current playbook in the instructions.
↳ referenced_tools
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.
↳ inline_actions
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.
↳ code_block
↳ llm_model_settings
↳ handlers
array< Handler
>
Optional. A list of registered handlers to execuate based on the specified triggers.
↳ playbook_type
int
Optional. Type of the playbook.
getName
The unique identifier of the playbook.
Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>
.
string
setName
The unique identifier of the playbook.
Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>
.
var
string
$this
getDisplayName
Required. The human-readable name of the playbook, unique within an agent.
string
setDisplayName
Required. The human-readable name of the playbook, unique within an agent.
var
string
$this
getGoal
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.
string
setGoal
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.
var
string
$this
getInputParameterDefinitions
Optional. Defined structured input parameters for this playbook.
setInputParameterDefinitions
Optional. Defined structured input parameters for this playbook.
$this
getOutputParameterDefinitions
Optional. Defined structured output parameters for this playbook.
setOutputParameterDefinitions
Optional. Defined structured output parameters for this playbook.
$this
getInstruction
Instruction to accomplish target goal.
hasInstruction
clearInstruction
setInstruction
Instruction to accomplish target goal.
$this
getTokenCount
Output only. Estimated number of tokes current playbook takes when sent to the LLM.
int|string
setTokenCount
Output only. Estimated number of tokes current playbook takes when sent to the LLM.
var
int|string
$this
getCreateTime
Output only. The timestamp of initial playbook creation.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp of initial playbook creation.
$this
getUpdateTime
Output only. Last time the playbook version was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last time the playbook version was updated.
$this
getReferencedPlaybooks
Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
setReferencedPlaybooks
Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
var
string[]
$this
getReferencedFlows
Output only. The resource name of flows referenced by the current playbook in the instructions.
setReferencedFlows
Output only. The resource name of flows referenced by the current playbook in the instructions.
var
string[]
$this
getReferencedTools
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.
setReferencedTools
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.
var
string[]
$this
getInlineActions
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.
setInlineActions
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.
var
string[]
$this
getCodeBlock
Optional. The playbook's scoped code block, which may implement handlers and actions.
hasCodeBlock
clearCodeBlock
setCodeBlock
Optional. The playbook's scoped code block, which may implement handlers and actions.
$this
getLlmModelSettings
Optional. Llm model settings for the playbook.
hasLlmModelSettings
clearLlmModelSettings
setLlmModelSettings
Optional. Llm model settings for the playbook.
$this
getHandlers
Optional. A list of registered handlers to execuate based on the specified triggers.
setHandlers
Optional. A list of registered handlers to execuate based on the specified triggers.
$this
getPlaybookType
Optional. Type of the playbook.
setPlaybookType
Optional. Type of the playbook.
$this
