Class GoogleCloudDialogflowCxV3beta1Playbook

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.

Inheritance

object

GoogleCloudDialogflowCxV3beta1Playbook

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Dialogflow.v3beta1.Data

Assembly: Google.Apis.Dialogflow.v3beta1.dll

Syntax

public class GoogleCloudDialogflowCxV3beta1Playbook : IDirectResponseSchema

Properties

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. The timestamp of initial playbook creation.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

DisplayName

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

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Goal

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

Declaration

[JsonProperty("goal")]
public virtual string Goal { get; set; }

Property Value

Type	Description
string

InputParameterDefinitions

Optional. Defined structured input parameters for this playbook.

Declaration

[JsonProperty("inputParameterDefinitions")]
public virtual IList<GoogleCloudDialogflowCxV3beta1ParameterDefinition> InputParameterDefinitions { get; set; }

Property Value

Type	Description
IList<GoogleCloudDialogflowCxV3beta1ParameterDefinition>

Instruction

Instruction to accomplish target goal.

Declaration

[JsonProperty("instruction")]
public virtual GoogleCloudDialogflowCxV3beta1PlaybookInstruction Instruction { get; set; }

Property Value

Type	Description
GoogleCloudDialogflowCxV3beta1PlaybookInstruction

LlmModelSettings

Optional. Llm model settings for the playbook.

Declaration

[JsonProperty("llmModelSettings")]
public virtual GoogleCloudDialogflowCxV3beta1LlmModelSettings LlmModelSettings { get; set; }

Property Value

Type	Description
GoogleCloudDialogflowCxV3beta1LlmModelSettings

Name

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

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

OutputParameterDefinitions

Optional. Defined structured output parameters for this playbook.

Declaration

[JsonProperty("outputParameterDefinitions")]
public virtual IList<GoogleCloudDialogflowCxV3beta1ParameterDefinition> OutputParameterDefinitions { get; set; }

Property Value

Type	Description
IList<GoogleCloudDialogflowCxV3beta1ParameterDefinition>

ReferencedFlows

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

Declaration

[JsonProperty("referencedFlows")]
public virtual IList<string> ReferencedFlows { get; set; }

Property Value

Type	Description
IList<string>

ReferencedPlaybooks

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

Declaration

[JsonProperty("referencedPlaybooks")]
public virtual IList<string> ReferencedPlaybooks { get; set; }

Property Value

Type	Description
IList<string>

ReferencedTools

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.

Declaration

[JsonProperty("referencedTools")]
public virtual IList<string> ReferencedTools { get; set; }

Property Value

Type	Description
IList<string>

TokenCount

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

Declaration

[JsonProperty("tokenCount")]
public virtual long? TokenCount { get; set; }

Property Value

Type	Description
long?

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. Last time the playbook version was updated.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema