Gemini Enterprise for Customer Experience v1beta API - Class App (1.0.0-beta01)

public sealed class App : IMessage<App>, IEquatable<App>, IDeepCloneable<App>, IBufferMessage, IMessage

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1beta API class App.

An app serves as a top-level container for a group of agents, including the root agent and its sub-agents, along with their associated configurations. These agents work together to achieve specific goals within the app's context.

Inheritance

object > App

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Constructors

App()

public App()

App(App)

public App(App other)
Parameter
Name Description
other App

Properties

AppName

public AppName AppName { get; set; }

AppName-typed view over the Name resource name property.

Property Value
Type Description
AppName

AudioProcessingConfig

public AudioProcessingConfig AudioProcessingConfig { get; set; }

Optional. Audio processing configuration of the app.

Property Value
Type Description
AudioProcessingConfig

ClientCertificateSettings

public ClientCertificateSettings ClientCertificateSettings { get; set; }

Optional. The default client certificate settings for the app.

Property Value
Type Description
ClientCertificateSettings

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when the app was created.

Property Value
Type Description
Timestamp

DataStoreSettings

public DataStoreSettings DataStoreSettings { get; set; }

Optional. The data store settings for the app.

Property Value
Type Description
DataStoreSettings

DefaultChannelProfile

public ChannelProfile DefaultChannelProfile { get; set; }

Optional. The default channel profile used by the app.

Property Value
Type Description
ChannelProfile

DeploymentCount

public int DeploymentCount { get; set; }

Output only. Number of deployments in the app.

Property Value
Type Description
int

Description

public string Description { get; set; }

Optional. Human-readable description of the app.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Required. Display name of the app.

Property Value
Type Description
string

ErrorHandlingSettings

public ErrorHandlingSettings ErrorHandlingSettings { get; set; }

Optional. Error handling settings of the app.

Property Value
Type Description
ErrorHandlingSettings

Etag

public string Etag { get; set; }

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

Property Value
Type Description
string

EvaluationMetricsThresholds

public EvaluationMetricsThresholds EvaluationMetricsThresholds { get; set; }

Optional. The evaluation thresholds for the app.

Property Value
Type Description
EvaluationMetricsThresholds

EvaluationPersonas

public RepeatedField<EvaluationPersona> EvaluationPersonas { get; }

Optional. The evaluation personas for the app. This field is used to define the personas that can be used for evaluation. Maximum of 30 personas can be defined.

Property Value
Type Description
RepeatedFieldEvaluationPersona

EvaluationSettings

public EvaluationSettings EvaluationSettings { get; set; }

Optional. The evaluation settings for the app.

Property Value
Type Description
EvaluationSettings

GlobalInstruction

public string GlobalInstruction { get; set; }

Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.

Property Value
Type Description
string

Guardrails

public RepeatedField<string> Guardrails { get; }

Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

Property Value
Type Description
RepeatedFieldstring

GuardrailsAsGuardrailNames

public ResourceNameList<GuardrailName> GuardrailsAsGuardrailNames { get; }

GuardrailName-typed view over the Guardrails resource name property.

Property Value
Type Description
ResourceNameListGuardrailName

LanguageSettings

public LanguageSettings LanguageSettings { get; set; }

Optional. Language settings of the app.

Property Value
Type Description
LanguageSettings

Locked

public bool Locked { get; set; }

Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.

Property Value
Type Description
bool

LoggingSettings

public LoggingSettings LoggingSettings { get; set; }

Optional. Logging settings of the app.

Property Value
Type Description
LoggingSettings

Metadata

public MapField<string, string> Metadata { get; }

Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.

Property Value
Type Description
MapFieldstringstring

ModelSettings

public ModelSettings ModelSettings { get; set; }

Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.

Property Value
Type Description
ModelSettings

Name

public string Name { get; set; }

Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}

Property Value
Type Description
string

Pinned

public bool Pinned { get; set; }

Optional. Whether the app is pinned in the app list.

Property Value
Type Description
bool

PredefinedVariableDeclarations

public RepeatedField<App.Types.VariableDeclaration> PredefinedVariableDeclarations { get; }

Output only. The declarations of predefined variables for the app.

Property Value
Type Description
RepeatedFieldAppTypesVariableDeclaration

RootAgent

public string RootAgent { get; set; }

Optional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

Property Value
Type Description
string

RootAgentAsAgentName

public AgentName RootAgentAsAgentName { get; set; }

AgentName-typed view over the RootAgent resource name property.

Property Value
Type Description
AgentName

TimeZoneSettings

public TimeZoneSettings TimeZoneSettings { get; set; }

Optional. TimeZone settings of the app.

Property Value
Type Description
TimeZoneSettings

ToolExecutionMode

public App.Types.ToolExecutionMode ToolExecutionMode { get; set; }

Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.

Property Value
Type Description
AppTypesToolExecutionMode

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp when the app was last updated.

Property Value
Type Description
Timestamp

VariableDeclarations

public RepeatedField<App.Types.VariableDeclaration> VariableDeclarations { get; }

Optional. The declarations of the variables.

Property Value
Type Description
RepeatedFieldAppTypesVariableDeclaration