GoogleCloudDialogflowCxV3Playbook

import type { GoogleCloudDialogflowCxV3Playbook } from "https://googleapis.deno.dev/v1/dialogflow:v3.ts";

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.

interface GoogleCloudDialogflowCxV3Playbook {

readonly createTime?: Date;

displayName?: string;

goal?: string;

handlers?: GoogleCloudDialogflowCxV3Handler[];

instruction?: GoogleCloudDialogflowCxV3PlaybookInstruction;

llmModelSettings?: GoogleCloudDialogflowCxV3LlmModelSettings;

name?: string;

readonly referencedFlows?: string[];

readonly referencedPlaybooks?: string[];

referencedTools?: string[];

readonly tokenCount?: bigint;

readonly updateTime?: Date;

}

§Properties

readonly createTime?: Date

[src]

Output only. The timestamp of initial playbook creation.

displayName?: string

[src]

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

goal?: string

[src]

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?: GoogleCloudDialogflowCxV3Handler[]

[src]

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

instruction?: GoogleCloudDialogflowCxV3PlaybookInstruction

[src]

Instruction to accomplish target goal.

llmModelSettings?: GoogleCloudDialogflowCxV3LlmModelSettings

[src]

Optional. Llm model settings for the playbook.

name?: string

[src]

The unique identifier of the playbook. Format: projects//locations//agents//playbooks/.

readonly referencedFlows?: string[]

[src]

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

readonly referencedPlaybooks?: string[]

[src]

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

referencedTools?: string[]

[src]

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.

readonly tokenCount?: bigint

[src]

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

readonly updateTime?: Date

[src]

Output only. Last time the playbook version was updated.