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 \ V1Methods
__construct
Constructor.
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
↳ time_zone_settings
↳ audio_processing_config
↳ logging_settings
↳ error_handling_settings
↳ 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
↳ variable_declarations
↳ predefined_variable_declarations
↳ 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
string[]
Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
↳ data_store_settings
↳ default_channel_profile
↳ 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
↳ update_time
↳ 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
↳ 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}
string
setName
Identifier. The unique identifier of the app.
Format: projects/{project}/locations/{location}/apps/{app}
var
string
$this
getDisplayName
Required. Display name of the app.
string
setDisplayName
Required. Display name of the app.
var
string
$this
getDescription
Optional. Human-readable description of the app.
string
setDescription
Optional. Human-readable description of the app.
var
string
$this
getPinned
Optional. Whether the app is pinned in the app list.
bool
setPinned
Optional. Whether the app is pinned in the app list.
var
bool
$this
getRootAgent
Optional. The root agent is the entry point of the app.
Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
string
setRootAgent
Optional. The root agent is the entry point of the app.
Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
var
string
$this
getLanguageSettings
Optional. Language settings of the app.
hasLanguageSettings
clearLanguageSettings
setLanguageSettings
Optional. Language settings of the app.
$this
getTimeZoneSettings
Optional. TimeZone settings of the app.
hasTimeZoneSettings
clearTimeZoneSettings
setTimeZoneSettings
Optional. TimeZone settings of the app.
$this
getAudioProcessingConfig
Optional. Audio processing configuration of the app.
hasAudioProcessingConfig
clearAudioProcessingConfig
setAudioProcessingConfig
Optional. Audio processing configuration of the app.
$this
getLoggingSettings
Optional. Logging settings of the app.
hasLoggingSettings
clearLoggingSettings
setLoggingSettings
Optional. Logging settings of the app.
$this
getErrorHandlingSettings
Optional. Error handling settings of the app.
hasErrorHandlingSettings
clearErrorHandlingSettings
setErrorHandlingSettings
Optional. Error handling settings of the app.
$this
getModelSettings
Optional. The default LLM model settings for the app.
Individual resources (e.g. agents, guardrails) can override these configurations as needed.
hasModelSettings
clearModelSettings
setModelSettings
Optional. The default LLM model settings for the app.
Individual resources (e.g. agents, guardrails) can override these configurations as needed.
$this
getToolExecutionMode
Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.
setToolExecutionMode
Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.
$this
getEvaluationMetricsThresholds
Optional. The evaluation thresholds for the app.
hasEvaluationMetricsThresholds
clearEvaluationMetricsThresholds
setEvaluationMetricsThresholds
Optional. The evaluation thresholds for the app.
$this
getVariableDeclarations
Optional. The declarations of the variables.
setVariableDeclarations
Optional. The declarations of the variables.
$this
getPredefinedVariableDeclarations
Output only. The declarations of predefined variables for the app.
setPredefinedVariableDeclarations
Output only. The declarations of predefined variables for the app.
$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.
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.
var
string
$this
getGuardrails
Optional. List of guardrails for the app.
Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
setGuardrails
Optional. List of guardrails for the app.
Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
var
string[]
$this
getDataStoreSettings
Optional. The data store settings for the app.
hasDataStoreSettings
clearDataStoreSettings
setDataStoreSettings
Optional. The data store settings for the app.
$this
getDefaultChannelProfile
Optional. The default channel profile used by the app.
hasDefaultChannelProfile
clearDefaultChannelProfile
setDefaultChannelProfile
Optional. The default channel profile used by the app.
$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.
setMetadata
Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
$this
getCreateTime
Output only. Timestamp when the app was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when the app was created.
$this
getUpdateTime
Output only. Timestamp when the app was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when the app was last updated.
$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.
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.
var
string
$this
getDeploymentCount
Output only. Number of deployments in the app.
int
setDeploymentCount
Output only. Number of deployments in the app.
var
int
$this
getClientCertificateSettings
Optional. The default client certificate settings for the app.
hasClientCertificateSettings
clearClientCertificateSettings
setClientCertificateSettings
Optional. The default client certificate settings for the app.
$this
getLocked
Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.
bool
setLocked
Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.
var
bool
$this
