App

import type { App } from "https://googleapis.deno.dev/v1/ces:v1.ts";

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.

interface App {

audioProcessingConfig?: AudioProcessingConfig;

clientCertificateSettings?: ClientCertificateSettings;

readonly createTime?: Date;

dataStoreSettings?: DataStoreSettings;

defaultChannelProfile?: ChannelProfile;

readonly deploymentCount?: number;

description?: string;

displayName?: string;

readonly etag?: string;

evaluationMetricsThresholds?: EvaluationMetricsThresholds;

globalInstruction?: string;

guardrails?: string[];

languageSettings?: LanguageSettings;

locked?: boolean;

loggingSettings?: LoggingSettings;

metadata?: {

[key: string]: string;

};

modelSettings?: ModelSettings;

name?: string;

pinned?: boolean;

readonly predefinedVariableDeclarations?: AppVariableDeclaration[];

rootAgent?: string;

timeZoneSettings?: TimeZoneSettings;

toolExecutionMode?: "TOOL_EXECUTION_MODE_UNSPECIFIED" | "PARALLEL" | "SEQUENTIAL";

readonly updateTime?: Date;

variableDeclarations?: AppVariableDeclaration[];

}

§Properties

audioProcessingConfig?: AudioProcessingConfig

[src]

Optional. Audio processing configuration of the app.

clientCertificateSettings?: ClientCertificateSettings

[src]

Optional. The default client certificate settings for the app.

readonly createTime?: Date

[src]

Output only. Timestamp when the app was created.

dataStoreSettings?: DataStoreSettings

[src]

Optional. The data store settings for the app.

defaultChannelProfile?: ChannelProfile

[src]

Optional. The default channel profile used by the app.

readonly deploymentCount?: number

[src]

Output only. Number of deployments in the app.

description?: string

[src]

Optional. Human-readable description of the app.

displayName?: string

[src]

Required. Display name of the app.

readonly etag?: string

[src]

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.

evaluationMetricsThresholds?: EvaluationMetricsThresholds

[src]

Optional. The evaluation thresholds for the app.

globalInstruction?: string

[src]

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.

guardrails?: string[]

[src]

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

languageSettings?: LanguageSettings

[src]

Optional. Language settings of the app.

locked?: boolean

[src]

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

loggingSettings?: LoggingSettings

[src]

Optional. Logging settings of the app.

metadata?: {

[key: string]: string;

}

[src]

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

modelSettings?: ModelSettings

[src]

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

name?: string

[src]

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

pinned?: boolean

[src]

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

readonly predefinedVariableDeclarations?: AppVariableDeclaration[]

[src]

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

rootAgent?: string

[src]

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

timeZoneSettings?: TimeZoneSettings

[src]

Optional. TimeZone settings of the app.

toolExecutionMode?: "TOOL_EXECUTION_MODE_UNSPECIFIED" | "PARALLEL" | "SEQUENTIAL"

[src]

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

readonly updateTime?: Date

[src]

Output only. Timestamp when the app was last updated.

variableDeclarations?: AppVariableDeclaration[]

[src]

Optional. The declarations of the variables.