Class App (0.3.0)

App(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Attributes
Name	Description
name	str Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}
display_name	str Required. Display name of the app.
description	str Optional. Human-readable description of the app.
pinned	bool Optional. Whether the app is pinned in the app list.
root_agent	str Optional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
language_settings	google.cloud.ces_v1.types.LanguageSettings Optional. Language settings of the app.
time_zone_settings	google.cloud.ces_v1.types.TimeZoneSettings Optional. TimeZone settings of the app.
audio_processing_config	google.cloud.ces_v1.types.AudioProcessingConfig Optional. Audio processing configuration of the app.
logging_settings	google.cloud.ces_v1.types.LoggingSettings Optional. Logging settings of the app.
error_handling_settings	google.cloud.ces_v1.types.ErrorHandlingSettings Optional. Error handling settings of the app.
model_settings	google.cloud.ces_v1.types.ModelSettings Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.
tool_execution_mode	google.cloud.ces_v1.types.App.ToolExecutionMode Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.
evaluation_metrics_thresholds	google.cloud.ces_v1.types.EvaluationMetricsThresholds Optional. The evaluation thresholds for the app.
variable_declarations	MutableSequence[google.cloud.ces_v1.types.App.VariableDeclaration] Optional. The declarations of the variables.
predefined_variable_declarations	MutableSequence[google.cloud.ces_v1.types.App.VariableDeclaration] Output only. The declarations of predefined variables for the app.
global_instruction	str 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	MutableSequence[str] Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
data_store_settings	google.cloud.ces_v1.types.DataStoreSettings Optional. The data store settings for the app.
default_channel_profile	google.cloud.ces_v1.types.ChannelProfile Optional. The default channel profile used by the app.
metadata	MutableMapping[str, str] Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. Timestamp when the app was created.
update_time	google.protobuf.timestamp_pb2.Timestamp Output only. Timestamp when the app was last updated.
etag	str 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.
deployment_count	int Output only. Number of deployments in the app.
client_certificate_settings	google.cloud.ces_v1.types.ClientCertificateSettings Optional. The default client certificate settings for the app.
locked	bool Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.

Classes

MetadataEntry

MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

ToolExecutionMode

ToolExecutionMode(value)

Defines the tool execution behavior if there are multiple tools being selected by the agent at the same time.

VariableDeclaration

VariableDeclaration(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Defines the structure and metadata for a variable.