Struct google_api_proto::google::cloud::dialogflow::cx::v3beta1::Playbook

pub struct Playbook {

    pub name: String,
    pub display_name: String,
    pub goal: String,
    pub input_parameter_definitions: Vec<ParameterDefinition>,
    pub output_parameter_definitions: Vec<ParameterDefinition>,
    pub steps: Vec<Step>,
    pub token_count: i64,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub referenced_playbooks: Vec<String>,
    pub referenced_flows: Vec<String>,
    pub referenced_tools: Vec<String>,
    pub llm_model_settings: Option<LlmModelSettings>,
}

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.

Fields

name: String

The unique identifier of the playbook. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

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.

input_parameter_definitions: Vec<ParameterDefinition>

Optional. Defined structured input parameters for this playbook.

output_parameter_definitions: Vec<ParameterDefinition>

Optional. Defined structured output parameters for this playbook.

steps: Vec<Step>

Ordered list of step by step execution instructions to accomplish target goal.

token_count: i64

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

create_time: Option<Timestamp>

Output only. The timestamp of initial playbook creation.

update_time: Option<Timestamp>

Output only. Last time the playbook version was updated.

referenced_playbooks: Vec<String>

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

referenced_flows: Vec<String>

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

referenced_tools: Vec<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.

llm_model_settings: Option<LlmModelSettings>

Optional. Llm model settings for the playbook.

Trait Implementations

impl Clone for Playbook

fn clone(&self) -> Playbook

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Playbook

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Playbook

fn default() -> Self

Returns the “default value” for a type.

impl Message for Playbook

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Playbook

fn eq(&self, other: &Playbook) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Playbook