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.
Implements
Inherited Members
Namespace: Google.Apis.CustomerEngagementSuite.v1beta.Data
Assembly: Google.Apis.CustomerEngagementSuite.v1beta.dll
Syntax
public class App : IDirectResponseSchema
Properties
AudioProcessingConfig
Optional. Audio processing configuration of the app.
Declaration
[JsonProperty("audioProcessingConfig")]
public virtual AudioProcessingConfig AudioProcessingConfig { get; set; }
Property Value
| Type | Description |
|---|---|
| AudioProcessingConfig |
ClientCertificateSettings
Optional. The default client certificate settings for the app.
Declaration
[JsonProperty("clientCertificateSettings")]
public virtual ClientCertificateSettings ClientCertificateSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| ClientCertificateSettings |
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. Timestamp when the app was created.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
DataStoreSettings
Optional. The data store settings for the app.
Declaration
[JsonProperty("dataStoreSettings")]
public virtual DataStoreSettings DataStoreSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| DataStoreSettings |
DefaultChannelProfile
Optional. The default channel profile used by the app.
Declaration
[JsonProperty("defaultChannelProfile")]
public virtual ChannelProfile DefaultChannelProfile { get; set; }
Property Value
| Type | Description |
|---|---|
| ChannelProfile |
DeploymentCount
Output only. Number of deployments in the app.
Declaration
[JsonProperty("deploymentCount")]
public virtual int? DeploymentCount { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
Description
Optional. Human-readable description of the app.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
DisplayName
Required. Display name of the app.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ETag
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.
Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
EvaluationMetricsThresholds
Optional. The evaluation thresholds for the app.
Declaration
[JsonProperty("evaluationMetricsThresholds")]
public virtual EvaluationMetricsThresholds EvaluationMetricsThresholds { get; set; }
Property Value
| Type | Description |
|---|---|
| EvaluationMetricsThresholds |
EvaluationPersonas
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.
Declaration
[JsonProperty("evaluationPersonas")]
public virtual IList<EvaluationPersona> EvaluationPersonas { get; set; }
Property Value
| Type | Description |
|---|---|
| IList<EvaluationPersona> |
EvaluationSettings
Optional. The evaluation settings for the app.
Declaration
[JsonProperty("evaluationSettings")]
public virtual EvaluationSettings EvaluationSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| EvaluationSettings |
GlobalInstruction
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.
Declaration
[JsonProperty("globalInstruction")]
public virtual string GlobalInstruction { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Guardrails
Optional. List of guardrails for the app. Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
Declaration
[JsonProperty("guardrails")]
public virtual IList<string> Guardrails { get; set; }
Property Value
| Type | Description |
|---|---|
| IList<string> |
LanguageSettings
Optional. Language settings of the app.
Declaration
[JsonProperty("languageSettings")]
public virtual LanguageSettings LanguageSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| LanguageSettings |
Locked
Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.
Declaration
[JsonProperty("locked")]
public virtual bool? Locked { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
LoggingSettings
Optional. Logging settings of the app.
Declaration
[JsonProperty("loggingSettings")]
public virtual LoggingSettings LoggingSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| LoggingSettings |
Metadata
Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
Declaration
[JsonProperty("metadata")]
public virtual IDictionary<string, string> Metadata { get; set; }
Property Value
| Type | Description |
|---|---|
| IDictionary<string, string> |
ModelSettings
Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.
Declaration
[JsonProperty("modelSettings")]
public virtual ModelSettings ModelSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| ModelSettings |
Name
Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Pinned
Optional. Whether the app is pinned in the app list.
Declaration
[JsonProperty("pinned")]
public virtual bool? Pinned { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
PredefinedVariableDeclarations
Output only. The declarations of predefined variables for the app.
Declaration
[JsonProperty("predefinedVariableDeclarations")]
public virtual IList<AppVariableDeclaration> PredefinedVariableDeclarations { get; set; }
Property Value
| Type | Description |
|---|---|
| IList<AppVariableDeclaration> |
RootAgent
Optional. The root agent is the entry point of the app. Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
Declaration
[JsonProperty("rootAgent")]
public virtual string RootAgent { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
TimeZoneSettings
Optional. TimeZone settings of the app.
Declaration
[JsonProperty("timeZoneSettings")]
public virtual TimeZoneSettings TimeZoneSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| TimeZoneSettings |
ToolExecutionMode
Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.
Declaration
[JsonProperty("toolExecutionMode")]
public virtual string ToolExecutionMode { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
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. Timestamp when the app was last updated.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
VariableDeclarations
Optional. The declarations of the variables.
Declaration
[JsonProperty("variableDeclarations")]
public virtual IList<AppVariableDeclaration> VariableDeclarations { get; set; }
Property Value
| Type | Description |
|---|---|
| IList<AppVariableDeclaration> |