GoogleCloudDialogflowCxV3Playbook class

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.

Constructors

GoogleCloudDialogflowCxV3Playbook.new({String? createTime, String? displayName, String? goal, List<GoogleCloudDialogflowCxV3Handler>? handlers, List<GoogleCloudDialogflowCxV3ParameterDefinition>? inputParameterDefinitions, GoogleCloudDialogflowCxV3PlaybookInstruction? instruction, GoogleCloudDialogflowCxV3LlmModelSettings? llmModelSettings, String? name, List<GoogleCloudDialogflowCxV3ParameterDefinition>? outputParameterDefinitions, String? playbookType, List<String>? referencedFlows, List<String>? referencedPlaybooks, List<String>? referencedTools, String? tokenCount, String? updateTime})

GoogleCloudDialogflowCxV3Playbook.fromJson(Map json_)

Properties

createTime ↔ String?

The timestamp of initial playbook creation.

getter/setter pair

displayName ↔ String?

The human-readable name of the playbook, unique within an agent.

getter/setter pair

goal ↔ String?

High level description of the goal the playbook intend to accomplish.

getter/setter pair

handlers ↔ List<GoogleCloudDialogflowCxV3Handler>?

A list of registered handlers to execuate based on the specified triggers.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

inputParameterDefinitions ↔ List<GoogleCloudDialogflowCxV3ParameterDefinition>?

Defined structured input parameters for this playbook.

getter/setter pair

instruction ↔ GoogleCloudDialogflowCxV3PlaybookInstruction?

Instruction to accomplish target goal.

getter/setter pair

llmModelSettings ↔ GoogleCloudDialogflowCxV3LlmModelSettings?

Llm model settings for the playbook.

getter/setter pair

name ↔ String?

The unique identifier of the playbook.

getter/setter pair

outputParameterDefinitions ↔ List<GoogleCloudDialogflowCxV3ParameterDefinition>?

Defined structured output parameters for this playbook.

getter/setter pair

playbookType ↔ String?

Type of the playbook.

getter/setter pair

referencedFlows ↔ List<String>?

The resource name of flows referenced by the current playbook in the instructions.

getter/setter pair

referencedPlaybooks ↔ List<String>?

The resource name of other playbooks referenced by the current playbook in the instructions.

getter/setter pair

referencedTools ↔ List<String>?

The resource name of tools referenced by the current playbook in the instructions.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tokenCount ↔ String?

Estimated number of tokes current playbook takes when sent to the LLM.

getter/setter pair

updateTime ↔ String?

Last time the playbook version was updated.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited