Gcp/ces
@swamp/gcp/cesv2026.09.15.1
01README
Google Cloud ces infrastructure models
02Release Notes
- Updated: apps_guardrails, apps_tools, apps_versions
03Models
apps.tsv2026.09.07.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| audioProcessingConfig? | object | Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in [Cloud Storage](https://cloud.google.com/storage). Note: Please make sure the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object. |
| clientCertificateSettings? | object | Optional. The name of the SecretManager secret version resource storing the passphrase to decrypt the private key. Should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` |
| dashboardSettings? | object | Optional. The resource name of the default Contact Center Insights dashboard associated with the app. This is the dashboard that will be displayed when users navigate to the Monitoring view for the app. Format: `projects/{project}/locations/{location}/dashboards/{dashboard}` |
| dataStoreSettings? | object | Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` |
| defaultChannelProfile? | object | Optional. The type of the channel profile. |
| description? | string | Optional. Human-readable description of the app. |
| displayName? | string | Required. Display name of the app. |
| errorHandlingSettings? | object | Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. |
| evaluationMetricsThresholds? | object | Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. |
| globalInstruction? | 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}` |
| languageSettings? | object | Optional. The default language code of the app. |
| locked? | boolean | Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. |
| loggingSettings? | object | Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. |
| metadata? | record | Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. |
| modelSettings? | object | Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent. |
| name? | string | Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}` |
| pinned? | boolean | Optional. Whether the app is pinned in the app list. |
| rootAgent? | string | Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| timeZoneSettings? | object | Optional. The time zone of the app from the [time zone database](https://www.iana.org/time-zones), e.g., America/Los_Angeles, Europe/Paris. |
| toolExecutionMode? | enum | Optional. The tool execution mode for the app. If not provided, will default to PARALLEL. |
| variableDeclarations? | array | Required. The description of the variable. |
| vpcScSettings? | object | Optional. The allowed HTTP(s) origins that OpenAPI tools in the App are able to directly call when VPC Service Controls are enabled. These strings must match the origin exactly, including the port if specified. For example, "https://example.com" or "https://example.com:443". This list does not yet apply to Python tools that may make direct HTTP calls. |
| appId? | string | Optional. The ID to use for the app, which will become the final component of the app's resource name. If not provided, a unique ID will be automatically assigned for the app. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a apps
fn get(identifier: string)
Get a apps
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apps |
fn update(identifier?: string)
Update apps attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific apps by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the apps
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apps |
fn sync(identifier?: string)
Sync apps state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific apps by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List apps resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the apps. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn execute_tool(args?: any, context?: any, mockConfig?: any, tool?: any, toolsetTool?: any, variables?: any)
execute tool
| Argument | Type | Description |
|---|---|---|
| args? | any | |
| context? | any | |
| mockConfig? | any | |
| tool? | any | |
| toolsetTool? | any | |
| variables? | any |
fn export_app(appVersion?: any, exportFormat?: any, gcsUri?: any)
export app
| Argument | Type | Description |
|---|---|---|
| appVersion? | any | |
| exportFormat? | any | |
| gcsUri? | any |
fn get_extended_agent_card()
get extended agent card
fn import_app(appContent?: any, appId?: any, displayName?: any, gcsUri?: any, ignoreAppLock?: any, importOptions?: any, jsonPatchContent?: any, jsonPatchGcsUri?: any)
import app
| Argument | Type | Description |
|---|---|---|
| appContent? | any | |
| appId? | any | |
| displayName? | any | |
| gcsUri? | any | |
| ignoreAppLock? | any | |
| importOptions? | any | |
| jsonPatchContent? | any | |
| jsonPatchGcsUri? | any |
fn retrieve_tool_schema(tool?: any, toolsetTool?: any)
retrieve tool schema
| Argument | Type | Description |
|---|---|---|
| tool? | any | |
| toolsetTool? | any |
Resources
state(infinite)— An app serves as a top-level container for a group of agents, including the r...
apps_agents.tsv2026.09.01.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| afterAgentCallbacks? | array | Optional. Human-readable description of the callback. |
| afterModelCallbacks? | array | Optional. Human-readable description of the callback. |
| afterToolCallbacks? | array | Optional. Human-readable description of the callback. |
| beforeAgentCallbacks? | array | Optional. Human-readable description of the callback. |
| beforeModelCallbacks? | array | Optional. Human-readable description of the callback. |
| beforeToolCallbacks? | array | Optional. Human-readable description of the callback. |
| childAgents? | array | Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| description? | string | Optional. Human-readable description of the agent. |
| displayName? | string | Required. Display name of the agent. |
| guardrails? | array | Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` |
| instruction? | string | Optional. Instructions for the LLM model to guide the agent's behavior. |
| llmAgent? | object | Optional. The default agent type. |
| modelSettings? | object | Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent. |
| name? | string | Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| remoteA2aAgent? | object | Required. A description of the agent's domain of action/solution space. |
| remoteDialogflowAgent? | object | Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}` |
| tools? | array | Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` |
| toolsets? | array | Optional. The tools IDs to filter the toolset. |
| transferRules? | array | Required. The resource name of the child agent the rule applies to. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| agentId? | string | Optional. The ID to use for the agent, which will become the final component of the agent's resource name. If not provided, a unique ID will be automatically assigned for the agent. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a agents
fn get(identifier: string)
Get a agents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the agents |
fn update(identifier?: string)
Update agents attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific agents by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the agents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the agents |
fn sync(identifier?: string)
Sync agents state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific agents by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List agents resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An agent acts as the fundamental building block that provides instructions to...
apps_changelogs.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a changelogs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the changelogs |
fn sync(identifier?: string)
Sync changelogs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific changelogs by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List changelogs resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the changelogs. See https://google.aip.dev/160 for more details. The filter string can be used to filter by `action`, `resource_type`, `resource_name`, `author`, and `create_time`. The `:` comparator can be used for case-insensitive partial matching on string fields, while `=` performs an exact case-sensitive match. Examples: * `action:update` (case-insensitive partial match) * `action="Create"` (case-sensitive exact match) * `resource_type:agent` * `resource_name:my-agent` * `author:me@example.com` * `create_time > "2025-01-01T00:00:00Z"` * `create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool` |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Changelogs represent a change made to the app or to an resource within the app.
apps_conversations.tsv2026.09.01.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
fn delete(identifier: string)
Delete the conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
fn sync(identifier?: string)
Sync conversations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific conversations by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, source?: string, sources?: string, maxPages?: number)
List conversations resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| source? | string | Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of `sources` field. |
| sources? | string | Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn batch_delete(conversations?: any)
batch delete
| Argument | Type | Description |
|---|---|---|
| conversations? | any |
Resources
state(infinite)— A conversation represents an interaction between an end user and the CES app.
apps_deployments.tsv2026.09.01.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| agentRegistryDeployment? | object | Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}` |
| appVersion? | string | Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. |
| channelProfile? | object | Optional. The type of the channel profile. |
| displayName? | string | Required. Display name of the deployment. |
| experimentConfig? | object | Optional. State of the version release. |
| instagramCredentials? | object | Required. The Meta auth code provided by the embedded signup flow. |
| modality? | enum | Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. |
| modelSettings? | object | Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent. |
| name? | string | Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` |
| whatsappCredentials? | object | Required. The Meta auth code provided by the embedded signup flow. |
| deploymentId? | string | Optional. The ID to use for the deployment, which will become the final component of the deployment's resource name. If not provided, a unique ID will be automatically assigned for the deployment. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a deployments
fn get(identifier: string)
Get a deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn update(identifier?: string)
Update deployments attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific deployments by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn sync(identifier?: string)
Sync deployments state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific deployments by name (e.g. one discovered by list) |
fn list(orderBy?: string, pageSize?: number, maxPages?: number)
List deployments resources
| Argument | Type | Description |
|---|---|---|
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_extended_agent_card()
get extended agent card
Resources
state(infinite)— A deployment represents an immutable, queryable version of the app. It is use...
apps_examples.tsv2026.09.01.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| description? | string | Optional. Human-readable description of the example. |
| displayName? | string | Required. Display name of the example. |
| entryAgent? | string | Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| messages? | array | Output only. Display name of the agent. |
| name? | string | Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}` |
| exampleId? | string | Optional. The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a examples
fn get(identifier: string)
Get a examples
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the examples |
fn update(identifier?: string)
Update examples attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific examples by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the examples
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the examples |
fn sync(identifier?: string)
Sync examples state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific examples by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List examples resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An example represents a sample conversation between the user and the agent(s).
apps_guardrails.tsv2026.09.15.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| action? | object | Required. The prompt to use for the generative answer. |
| codeCallback? | object | Optional. Human-readable description of the callback. |
| contentFilter? | object | Optional. List of banned phrases. Applies to both user inputs and agent responses. |
| description? | string | Optional. Description of the guardrail. |
| displayName? | string | Required. Display name of the guardrail. |
| enabled? | boolean | Optional. Whether the guardrail is enabled. |
| llmPolicy? | object | Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped. |
| llmPromptSecurity? | object | Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped. |
| modelSafety? | object | Required. The harm category. |
| name? | string | Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` |
| supervisor? | object | Optional. The detection mode of the supervisor. |
| guardrailId? | string | Optional. The ID to use for the guardrail, which will become the final component of the guardrail's resource name. If not provided, a unique ID will be automatically assigned for the guardrail. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a guardrails
fn get(identifier: string)
Get a guardrails
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the guardrails |
fn update(identifier?: string)
Update guardrails attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific guardrails by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the guardrails
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the guardrails |
fn sync(identifier?: string)
Sync guardrails state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific guardrails by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List guardrails resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the guardrails. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Guardrail contains a list of checks and balances to keep the agents safe and ...
apps_tools.tsv2026.09.15.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| agentTool? | object | Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` |
| clientFunction? | object | Optional. The function description. |
| connectorTool? | object | ID of a Connection action for the tool to use. |
| dataStoreTool? | object | Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. |
| executionType? | enum | Optional. The execution type of the tool. |
| fileSearchTool? | object | Optional. The type of the corpus. Default is FULLY_MANAGED. |
| googleSearchTool? | object | Optional. Content will be fetched directly from these URLs for context and grounding. Example: "https://example.com/path.html". A maximum of 20 URLs are allowed. |
| mcpTool? | object | Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. |
| name? | string | Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. |
| openApiTool? | object | Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. |
| pythonFunction? | object | Output only. The description of the Python function, parsed from the python code's docstring. |
| remoteAgentTool? | object | Required. A description of the agent's domain of action/solution space. |
| systemTool? | object | Output only. The description of the system tool. |
| timeout? | string | Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools. |
| toolFakeConfig? | object | Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. |
| widgetTool? | object | Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. |
| toolId? | string | Optional. The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a tools
fn get(identifier: string)
Get a tools
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tools |
fn update(identifier?: string)
Update tools attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tools by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the tools
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tools |
fn sync(identifier?: string)
Sync tools state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tools by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List tools resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the tools. Use "include_system_tools=true" to include system tools in the response. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A tool represents an action that the CES agent can take to achieve certain go...
apps_toolsets.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| connectorToolset? | object | Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`. |
| description? | string | Optional. The description of the toolset. |
| displayName? | string | Optional. The display name of the toolset. Must be unique within the same app. |
| executionType? | enum | Optional. The execution type of the tools in the toolset. |
| mcpToolset? | object | Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. |
| name? | string | Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` |
| openApiToolset? | object | Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. |
| timeout? | string | Optional. The timeout for the toolset execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` toolsets and 60 seconds for `ASYNCHRONOUS` toolsets. |
| toolFakeConfig? | object | Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. |
| toolsetId? | string | Optional. The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a toolsets
fn get(identifier: string)
Get a toolsets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the toolsets |
fn update(identifier?: string)
Update toolsets attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific toolsets by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the toolsets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the toolsets |
fn sync(identifier?: string)
Sync toolsets state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific toolsets by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List toolsets resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the toolsets. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn retrieve_tools(bypassPersistenceConfig?: any, toolIds?: any)
retrieve tools
| Argument | Type | Description |
|---|---|---|
| bypassPersistenceConfig? | any | |
| toolIds? | any |
Resources
state(infinite)— A toolset represents a group of dynamically managed tools that can be used by...
apps_versions.tsv2026.09.15.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| description? | string | Optional. The description of the app version. |
| displayName? | string | Optional. The display name of the app version. |
| name? | string | Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` |
| appVersionId? | string | Optional. The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a versions
fn get(identifier: string)
Get a versions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the versions |
fn update(identifier?: string)
Update versions attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific versions by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the versions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the versions |
fn sync(identifier?: string)
Sync versions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific versions by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List versions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the app versions. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_extended_agent_card()
get extended agent card
fn restore()
restore
Resources
state(infinite)— In Customer Engagement Suite (CES), an app version is a snapshot of the app a...
locations.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| name | string | The resource that owns the locations collection, if applicable. |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync(identifier?: string)
Sync locations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific locations by name (e.g. one discovered by list) |
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
| Argument | Type | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| pageSize? | number | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A resource that represents a Google Cloud location.
04Previous Versions
2026.09.07.1
- Updated: apps, apps_versions
2026.09.01.1
- Updated: apps_agents, apps_conversations, apps_deployments, apps_examples, apps_versions
2026.08.28.1
- Updated: apps, apps_conversations, apps_examples, apps_guardrails, apps_tools, apps_versions
Added 1, removed 11 models
2026.08.20.1
- Updated: apps_conversations
2026.08.12.2
- Updated: locations, apps, apps_agents, apps_changelogs, apps_conversations, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
2026.08.02.1
- Updated: apps, apps_conversations, apps_deployments, apps_tools
2026.07.29.1
- Updated: locations, apps, apps_agents, apps_changelogs, apps_conversations, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
2026.07.21.3
- Updated: locations, apps, apps_agents, apps_changelogs, apps_conversations, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
2026.07.21.1
- Updated: apps, apps_agents, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
2026.07.20.2
- Updated: locations, apps, apps_agents, apps_deployments, apps_tools, apps_toolsets, apps_versions
Modified 3 models
2026.07.20.1
- Updated: locations, apps, apps_agents, apps_changelogs, apps_conversations, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
Modified 3 models
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, apps, apps_agents, apps_changelogs, apps_conversations, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
2026.07.18.2
- Updated: locations, apps, apps_agents, apps_changelogs, apps_conversations, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
2026.07.17.2
- Updated: apps, apps_agents, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
2026.07.17.1
- Updated: apps, apps_agents, apps_changelogs, apps_conversations, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
2026.07.13.1
- Updated: apps, apps_deployments, apps_toolsets, apps_versions
Modified 2 models
2026.07.09.1
- Updated: apps, apps_deployments, apps_tools, apps_versions
Added 11, removed 1 models
2026.06.12.1
- Updated: apps_agents, apps_tools, apps_toolsets, apps_versions
05Stats
A
100 / 100
Downloads
0
Archive size
279.5 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels