Google Cloud Ces V1 Client - Class App (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client 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.

Generated from protobuf message google.cloud.ces.v1.App

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}
↳ display_name	string Required. Display name of the app.
↳ description	string Optional. Human-readable description of the app.
↳ pinned	bool Optional. Whether the app is pinned in the app list.
↳ root_agent	string Optional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
↳ language_settings	LanguageSettings Optional. Language settings of the app.
↳ time_zone_settings	TimeZoneSettings Optional. TimeZone settings of the app.
↳ audio_processing_config	AudioProcessingConfig Optional. Audio processing configuration of the app.
↳ logging_settings	LoggingSettings Optional. Logging settings of the app.
↳ model_settings	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	int Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.
↳ evaluation_metrics_thresholds	EvaluationMetricsThresholds Optional. The evaluation thresholds for the app.
↳ variable_declarations	array<App\VariableDeclaration> Optional. The declarations of the variables.
↳ predefined_variable_declarations	array<App\VariableDeclaration> Output only. The declarations of predefined variables for the app.
↳ global_instruction	string 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	array Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
↳ data_store_settings	DataStoreSettings Optional. The data store settings for the app.
↳ default_channel_profile	ChannelProfile Optional. The default channel profile used by the app.
↳ metadata	array|Google\Protobuf\Internal\MapField 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 Output only. Timestamp when the app was created.
↳ update_time	Google\Protobuf\Timestamp Output only. Timestamp when the app was last updated.
↳ etag	string 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	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.

getName

Identifier. The unique identifier of the app.

Format: projects/{project}/locations/{location}/apps/{app}

Returns
Type	Description
string

setName

Identifier. The unique identifier of the app.

Format: projects/{project}/locations/{location}/apps/{app}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

Required. Display name of the app.

Returns
Type	Description
string

setDisplayName

Required. Display name of the app.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

Optional. Human-readable description of the app.

Returns
Type	Description
string

setDescription

Optional. Human-readable description of the app.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPinned

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

Returns
Type	Description
bool

setPinned

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

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getRootAgent

Optional. The root agent is the entry point of the app.

Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

Returns
Type	Description
string

setRootAgent

Optional. The root agent is the entry point of the app.

Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLanguageSettings

Optional. Language settings of the app.

Returns
Type	Description
LanguageSettings|null

hasLanguageSettings

clearLanguageSettings

setLanguageSettings

Optional. Language settings of the app.

Parameter
Name	Description
var	LanguageSettings

Returns
Type	Description
$this

getTimeZoneSettings

Optional. TimeZone settings of the app.

Returns
Type	Description
TimeZoneSettings|null

hasTimeZoneSettings

clearTimeZoneSettings

setTimeZoneSettings

Optional. TimeZone settings of the app.

Parameter
Name	Description
var	TimeZoneSettings

Returns
Type	Description
$this

getAudioProcessingConfig

Optional. Audio processing configuration of the app.

Returns
Type	Description
AudioProcessingConfig|null

hasAudioProcessingConfig

clearAudioProcessingConfig

setAudioProcessingConfig

Optional. Audio processing configuration of the app.

Parameter
Name	Description
var	AudioProcessingConfig

Returns
Type	Description
$this

getLoggingSettings

Optional. Logging settings of the app.

Returns
Type	Description
LoggingSettings|null

hasLoggingSettings

clearLoggingSettings

setLoggingSettings

Optional. Logging settings of the app.

Parameter
Name	Description
var	LoggingSettings

Returns
Type	Description
$this

getModelSettings

Optional. The default LLM model settings for the app.

Individual resources (e.g. agents, guardrails) can override these configurations as needed.

Returns
Type	Description
ModelSettings|null

hasModelSettings

clearModelSettings

setModelSettings

Optional. The default LLM model settings for the app.

Individual resources (e.g. agents, guardrails) can override these configurations as needed.

Parameter
Name	Description
var	ModelSettings

Returns
Type	Description
$this

getToolExecutionMode

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

Returns
Type	Description
int	Enum of type ToolExecutionMode.

setToolExecutionMode

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

Parameter
Name	Description
var	int Enum of type ToolExecutionMode.

Returns
Type	Description
$this

getEvaluationMetricsThresholds

Optional. The evaluation thresholds for the app.

Returns
Type	Description
EvaluationMetricsThresholds|null

hasEvaluationMetricsThresholds

clearEvaluationMetricsThresholds

setEvaluationMetricsThresholds

Optional. The evaluation thresholds for the app.

Parameter
Name	Description
var	EvaluationMetricsThresholds

Returns
Type	Description
$this

getVariableDeclarations

Optional. The declarations of the variables.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setVariableDeclarations

Optional. The declarations of the variables.

Parameter
Name	Description
var	array<App\VariableDeclaration>

Returns
Type	Description
$this

getPredefinedVariableDeclarations

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

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setPredefinedVariableDeclarations

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

Parameter
Name	Description
var	array<App\VariableDeclaration>

Returns
Type	Description
$this

getGlobalInstruction

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.

Returns
Type	Description
string

setGlobalInstruction

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getGuardrails

Optional. List of guardrails for the app.

Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setGuardrails

Optional. List of guardrails for the app.

Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getDataStoreSettings

Optional. The data store settings for the app.

Returns
Type	Description
DataStoreSettings|null

hasDataStoreSettings

clearDataStoreSettings

setDataStoreSettings

Optional. The data store settings for the app.

Parameter
Name	Description
var	DataStoreSettings

Returns
Type	Description
$this

getDefaultChannelProfile

Optional. The default channel profile used by the app.

Returns
Type	Description
ChannelProfile|null

hasDefaultChannelProfile

clearDefaultChannelProfile

setDefaultChannelProfile

Optional. The default channel profile used by the app.

Parameter
Name	Description
var	ChannelProfile

Returns
Type	Description
$this

getMetadata

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

Returns
Type	Description
Google\Protobuf\Internal\MapField

setMetadata

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

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getCreateTime

Output only. Timestamp when the app was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when the app was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. Timestamp when the app was last updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when the app was last updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getEtag

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.

Returns
Type	Description
string

setEtag

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDeploymentCount

Output only. Number of deployments in the app.

Returns
Type	Description
int

setDeploymentCount

Output only. Number of deployments in the app.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getClientCertificateSettings

Optional. The default client certificate settings for the app.

Returns
Type	Description
ClientCertificateSettings|null

hasClientCertificateSettings

clearClientCertificateSettings

setClientCertificateSettings

Optional. The default client certificate settings for the app.

Parameter
Name	Description
var	ClientCertificateSettings

Returns
Type	Description
$this

getLocked

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

Returns
Type	Description
bool

setLocked

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

Parameter
Name	Description
var	bool

Returns
Type	Description
$this