Skip to main content

apps

Creates, updates, deletes, gets or lists an apps resource.

Overview

Nameapps
TypeResource
Idgoogle.ces.apps

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringIdentifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}
audioProcessingConfigobjectOptional. Audio processing configuration of the app. (id: AudioProcessingConfig)
clientCertificateSettingsobjectOptional. The default client certificate settings for the app. (id: ClientCertificateSettings)
createTimestring (google-datetime)Output only. Timestamp when the app was created.
dataStoreSettingsobjectOptional. The data store settings for the app. (id: DataStoreSettings)
defaultChannelProfileobjectOptional. The default channel profile used by the app. (id: ChannelProfile)
deploymentCountinteger (int32)Output only. Number of deployments in the app.
descriptionstringOptional. Human-readable description of the app.
displayNamestringRequired. Display name of the app.
errorHandlingSettingsobjectOptional. Error handling settings of the app. (id: ErrorHandlingSettings)
etagstringOutput 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.
evaluationMetricsThresholdsobjectOptional. The evaluation thresholds for the app. (id: EvaluationMetricsThresholds)
globalInstructionstringOptional. 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.
guardrailsarrayOptional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
languageSettingsobjectOptional. Language settings of the app. (id: LanguageSettings)
lockedbooleanOptional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.
loggingSettingsobjectOptional. Logging settings of the app. (id: LoggingSettings)
metadataobjectOptional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
modelSettingsobjectOptional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed. (id: ModelSettings)
pinnedbooleanOptional. Whether the app is pinned in the app list.
predefinedVariableDeclarationsarrayOutput only. The declarations of predefined variables for the app.
rootAgentstringOptional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
timeZoneSettingsobjectOptional. TimeZone settings of the app. (id: TimeZoneSettings)
toolExecutionModestringOptional. The tool execution mode for the app. If not provided, will default to PARALLEL. (TOOL_EXECUTION_MODE_UNSPECIFIED, PARALLEL, SEQUENTIAL)
updateTimestring (google-datetime)Output only. Timestamp when the app was last updated.
validationErrorsarrayOutput only. Misconfigurations or warnings in the app.
variableDeclarationsarrayOptional. The declarations of the variables.
vpcScSettingsobjectOptional. VPC-SC settings for the app. (id: VpcScSettings)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, appsIdGets details of the specified app.
listselectprojectsId, locationsIdfilter, orderBy, pageSize, pageTokenLists apps in the given project and location.
createinsertprojectsId, locationsIdappIdCreates a new app in the given project and location.
patchupdateprojectsId, locationsId, appsIdupdateMaskUpdates the specified app.
deletedeleteprojectsId, locationsId, appsIdetagDeletes the specified app.
execute_toolexecprojectsId, locationsId, appsIdExecutes the given tool with the given arguments.
import_appexecprojectsId, locationsIdImports the specified app.
export_appexecprojectsId, locationsId, appsIdExports the specified app.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
appsIdstring
locationsIdstring
projectsIdstring
appIdstring
etagstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
updateMaskstring (google-fieldmask)

SELECT examples

Gets details of the specified app.

SELECT
name,
audioProcessingConfig,
clientCertificateSettings,
createTime,
dataStoreSettings,
defaultChannelProfile,
deploymentCount,
description,
displayName,
errorHandlingSettings,
etag,
evaluationMetricsThresholds,
globalInstruction,
guardrails,
languageSettings,
locked,
loggingSettings,
metadata,
modelSettings,
pinned,
predefinedVariableDeclarations,
rootAgent,
timeZoneSettings,
toolExecutionMode,
updateTime,
validationErrors,
variableDeclarations,
vpcScSettings
FROM google.ces.apps
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND appsId = '{{ appsId }}' -- required
;

INSERT examples

Creates a new app in the given project and location.

INSERT INTO google.ces.apps (
data__timeZoneSettings,
data__metadata,
data__vpcScSettings,
data__loggingSettings,
data__toolExecutionMode,
data__defaultChannelProfile,
data__clientCertificateSettings,
data__errorHandlingSettings,
data__languageSettings,
data__modelSettings,
data__pinned,
data__globalInstruction,
data__guardrails,
data__name,
data__displayName,
data__locked,
data__variableDeclarations,
data__description,
data__audioProcessingConfig,
data__dataStoreSettings,
data__evaluationMetricsThresholds,
data__rootAgent,
projectsId,
locationsId,
appId
)
SELECT
'{{ timeZoneSettings }}',
'{{ metadata }}',
'{{ vpcScSettings }}',
'{{ loggingSettings }}',
'{{ toolExecutionMode }}',
'{{ defaultChannelProfile }}',
'{{ clientCertificateSettings }}',
'{{ errorHandlingSettings }}',
'{{ languageSettings }}',
'{{ modelSettings }}',
{{ pinned }},
'{{ globalInstruction }}',
'{{ guardrails }}',
'{{ name }}',
'{{ displayName }}',
{{ locked }},
'{{ variableDeclarations }}',
'{{ description }}',
'{{ audioProcessingConfig }}',
'{{ dataStoreSettings }}',
'{{ evaluationMetricsThresholds }}',
'{{ rootAgent }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ appId }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples

Updates the specified app.

UPDATE google.ces.apps
SET
data__timeZoneSettings = '{{ timeZoneSettings }}',
data__metadata = '{{ metadata }}',
data__vpcScSettings = '{{ vpcScSettings }}',
data__loggingSettings = '{{ loggingSettings }}',
data__toolExecutionMode = '{{ toolExecutionMode }}',
data__defaultChannelProfile = '{{ defaultChannelProfile }}',
data__clientCertificateSettings = '{{ clientCertificateSettings }}',
data__errorHandlingSettings = '{{ errorHandlingSettings }}',
data__languageSettings = '{{ languageSettings }}',
data__modelSettings = '{{ modelSettings }}',
data__pinned = {{ pinned }},
data__globalInstruction = '{{ globalInstruction }}',
data__guardrails = '{{ guardrails }}',
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__locked = {{ locked }},
data__variableDeclarations = '{{ variableDeclarations }}',
data__description = '{{ description }}',
data__audioProcessingConfig = '{{ audioProcessingConfig }}',
data__dataStoreSettings = '{{ dataStoreSettings }}',
data__evaluationMetricsThresholds = '{{ evaluationMetricsThresholds }}',
data__rootAgent = '{{ rootAgent }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND appsId = '{{ appsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
audioProcessingConfig,
clientCertificateSettings,
createTime,
dataStoreSettings,
defaultChannelProfile,
deploymentCount,
description,
displayName,
errorHandlingSettings,
etag,
evaluationMetricsThresholds,
globalInstruction,
guardrails,
languageSettings,
locked,
loggingSettings,
metadata,
modelSettings,
pinned,
predefinedVariableDeclarations,
rootAgent,
timeZoneSettings,
toolExecutionMode,
updateTime,
validationErrors,
variableDeclarations,
vpcScSettings;

DELETE examples

Deletes the specified app.

DELETE FROM google.ces.apps
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND appsId = '{{ appsId }}' --required
AND etag = '{{ etag }}'
;

Lifecycle Methods

Executes the given tool with the given arguments.

EXEC google.ces.apps.execute_tool
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@appsId='{{ appsId }}' --required
@@json=
'{
"tool": "{{ tool }}",
"args": "{{ args }}",
"variables": "{{ variables }}",
"toolsetTool": "{{ toolsetTool }}",
"mockConfig": "{{ mockConfig }}",
"context": "{{ context }}"
}'
;