{ "description": "", "endpoints": [ { "location": "us", "description": "Regional Endpoint", "endpointUrl": "https://ces.us.rep.googleapis.com/" }, { "endpointUrl": "https://ces.eu.rep.googleapis.com/", "location": "eu", "description": "Regional Endpoint" } ], "servicePath": "", "rootUrl": "https://ces.googleapis.com/", "id": "ces:v1", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "extraLocationTypes": { "repeated": true, "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "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).", "type": "string" }, "pageToken": { "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string" }, "name": { "pattern": "^projects/[^/]+$", "location": "path", "description": "The resource that owns the locations collection, if applicable.", "required": true, "type": "string" }, "pageSize": { "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "format": "int32" } }, "id": "ces.projects.locations.list", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "path": "v1/{+name}/locations", "response": { "$ref": "ListLocationsResponse" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Resource name for the location.", "required": true, "type": "string" } }, "httpMethod": "GET", "id": "ces.projects.locations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "path": "v1/{+name}", "response": { "$ref": "Location" }, "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "cancel": { "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1/{+name}:cancel", "response": { "$ref": "Empty" }, "id": "ces.projects.locations.operations.cancel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "request": { "$ref": "CancelOperationRequest" }, "httpMethod": "POST" }, "list": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "required": true, "type": "string" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageSize": { "description": "The standard list page size.", "type": "integer", "format": "int32", "location": "query" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" } }, "httpMethod": "GET", "id": "ces.projects.locations.operations.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "path": "v1/{+name}/operations", "response": { "$ref": "ListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path" } }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "id": "ces.projects.locations.operations.get", "path": "v1/{+name}", "response": { "$ref": "Operation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1/{+name}", "response": { "$ref": "Empty" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "id": "ces.projects.locations.operations.delete", "httpMethod": "DELETE" } } }, "apps": { "methods": { "exportApp": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The resource name of the app to export.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:exportApp", "id": "ces.projects.locations.apps.exportApp", "httpMethod": "POST", "request": { "$ref": "ExportAppRequest" }, "description": "Exports the specified app.", "path": "v1/{+name}:exportApp", "response": { "$ref": "Operation" } }, "getExtendedAgentCard": { "parameters": { "tenant": { "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "tenant" ], "path": "v1/{+tenant}/extendedAgentCard", "response": { "$ref": "LfA2aV1AgentCard" }, "description": "Gets the extended agent card for the authenticated agent.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/extendedAgentCard", "id": "ces.projects.locations.apps.getExtendedAgentCard" }, "executeTool": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "description": "Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:executeTool", "id": "ces.projects.locations.apps.executeTool", "httpMethod": "POST", "request": { "$ref": "ExecuteToolRequest" }, "description": "Executes the given tool with the given arguments.", "path": "v1/{+parent}:executeTool", "response": { "$ref": "ExecuteToolResponse" } }, "get": { "description": "Gets details of the specified app.", "path": "v1/{+name}", "response": { "$ref": "App" }, "id": "ces.projects.locations.apps.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to retrieve.", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "description": "Updates the specified app.", "path": "v1/{+name}", "response": { "$ref": "App" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "id": "ces.projects.locations.apps.patch", "httpMethod": "PATCH", "request": { "$ref": "App" }, "parameters": { "name": { "description": "Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "updateMask": { "location": "query", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "path": "v1/{+parent}/apps", "response": { "$ref": "Operation" }, "description": "Creates a new app in the given project and location.", "request": { "$ref": "App" }, "httpMethod": "POST", "id": "ces.projects.locations.apps.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps", "parameters": { "parent": { "description": "Required. The resource name of the location to create an app in.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "appId": { "description": "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.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "delete": { "description": "Deletes the specified app.", "path": "v1/{+name}", "response": { "$ref": "Operation" }, "id": "ces.projects.locations.apps.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the app to delete.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "etag": { "location": "query", "description": "Optional. The current etag of the app. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app, deletion will be blocked and an ABORTED error will be returned.", "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "retrieveToolSchema": { "description": "Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.", "path": "v1/{+parent}:retrieveToolSchema", "response": { "$ref": "RetrieveToolSchemaResponse" }, "id": "ces.projects.locations.apps.retrieveToolSchema", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:retrieveToolSchema", "request": { "$ref": "RetrieveToolSchemaRequest" }, "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The resource name of the location to list apps from.", "required": true, "type": "string" }, "filter": { "location": "query", "description": "Optional. Filter to be applied when listing the apps. See https://google.aip.dev/160 for more details.", "type": "string" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListApps call.", "type": "string", "location": "query" }, "orderBy": { "location": "query", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string" } }, "httpMethod": "GET", "id": "ces.projects.locations.apps.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps", "path": "v1/{+parent}/apps", "response": { "$ref": "ListAppsResponse" }, "description": "Lists apps in the given project and location." }, "importApp": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource name with the location of the app to import.", "required": true, "type": "string" } }, "request": { "$ref": "ImportAppRequest" }, "httpMethod": "POST", "id": "ces.projects.locations.apps.importApp", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps:importApp", "path": "v1/{+parent}/apps:importApp", "response": { "$ref": "Operation" }, "description": "Imports the specified app." } }, "resources": { "toolsets": { "methods": { "list": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "filter": { "location": "query", "description": "Optional. Filter to be applied when listing the toolsets. See https://google.aip.dev/160 for more details.", "type": "string" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListToolsets call.", "type": "string", "location": "query" }, "orderBy": { "location": "query", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string" }, "parent": { "description": "Required. The resource name of the app to list toolsets from.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "format": "int32", "location": "query" } }, "id": "ces.projects.locations.apps.toolsets.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets", "httpMethod": "GET", "description": "Lists toolsets in the given app.", "path": "v1/{+parent}/toolsets", "response": { "$ref": "ListToolsetsResponse" } }, "get": { "description": "Gets details of the specified toolset.", "path": "v1/{+name}", "response": { "$ref": "Toolset" }, "id": "ces.projects.locations.apps.toolsets.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the toolset to retrieve.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "location": "path" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "location": "path", "description": "Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "required": true, "type": "string" }, "updateMask": { "location": "query", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "type": "string", "format": "google-fieldmask" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}", "id": "ces.projects.locations.apps.toolsets.patch", "httpMethod": "PATCH", "request": { "$ref": "Toolset" }, "description": "Updates the specified toolset.", "path": "v1/{+name}", "response": { "$ref": "Toolset" } }, "retrieveTools": { "parameterOrder": [ "toolset" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "toolset": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "location": "path", "description": "Required. The name of the toolset to retrieve the tools for. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "required": true, "type": "string" } }, "id": "ces.projects.locations.apps.toolsets.retrieveTools", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}:retrieveTools", "request": { "$ref": "RetrieveToolsRequest" }, "httpMethod": "POST", "description": "Retrieve the list of tools included in the specified toolset.", "path": "v1/{+toolset}:retrieveTools", "response": { "$ref": "RetrieveToolsResponse" } }, "create": { "description": "Creates a new toolset in the given app.", "path": "v1/{+parent}/toolsets", "response": { "$ref": "Toolset" }, "id": "ces.projects.locations.apps.toolsets.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets", "request": { "$ref": "Toolset" }, "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to create a toolset in.", "required": true, "type": "string" }, "toolsetId": { "description": "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.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameters": { "name": { "description": "Required. The resource name of the toolset to delete.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "location": "path" }, "force": { "location": "query", "description": "Optional. Indicates whether to forcefully delete the toolset, even if it is still referenced by app/agents. * If `force = false`, the deletion fails if any agents still reference the toolset. * If `force = true`, all existing references from agents will be removed and the toolset will be deleted.", "type": "boolean" }, "etag": { "location": "query", "description": "Optional. The current etag of the toolset. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the toolset, deletion will be blocked and an ABORTED error will be returned.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "Empty" }, "description": "Deletes the specified toolset.", "httpMethod": "DELETE", "id": "ces.projects.locations.apps.toolsets.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}" } } }, "conversations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The resource name of the conversation to retrieve.", "required": true, "type": "string" }, "source": { "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "deprecated": true, "location": "query", "description": "Optional. Indicate the source of the conversation. If not set, all source will be searched.", "type": "string" }, "view": { "description": "Optional. The view specifying which fields in the response should be populated.", "type": "string", "location": "query", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "CONVERSATION_VIEW_BASIC", "CONVERSATION_VIEW_FULL" ], "enumDescriptions": [ "Not specified, defaults to CONVERSATION_VIEW_BASIC.", "The basic view. Returns everything except resolved instructions.", "The full view. Includes resolved instructions dynamically per turn." ] } }, "httpMethod": "GET", "id": "ces.projects.locations.apps.conversations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}", "path": "v1/{+name}", "response": { "$ref": "Conversation" }, "description": "Gets details of the specified conversation." }, "delete": { "path": "v1/{+name}", "response": { "$ref": "Empty" }, "description": "Deletes the specified conversation.", "httpMethod": "DELETE", "id": "ces.projects.locations.apps.conversations.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The resource name of the conversation to delete.", "required": true, "type": "string" }, "source": { "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "deprecated": true, "description": "Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "batchDelete": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Batch deletes the specified conversations.", "path": "v1/{+parent}/conversations:batchDelete", "response": { "$ref": "Operation" }, "id": "ces.projects.locations.apps.conversations.batchDelete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations:batchDelete", "request": { "$ref": "BatchDeleteConversationsRequest" }, "httpMethod": "POST" }, "list": { "id": "ces.projects.locations.apps.conversations.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations", "httpMethod": "GET", "description": "Lists conversations in the given app.", "path": "v1/{+parent}/conversations", "response": { "$ref": "ListConversationsResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "format": "int32", "location": "query" }, "sources": { "description": "Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default.", "type": "string", "location": "query", "repeated": true, "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ] }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to list conversations from.", "required": true, "type": "string" }, "source": { "location": "query", "description": "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.", "type": "string", "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ] }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.", "type": "string" }, "filter": { "location": "query", "description": "Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details.", "type": "string" } } } } }, "agents": { "methods": { "get": { "parameters": { "name": { "description": "Required. The resource name of the agent to retrieve.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "Agent" }, "description": "Gets details of the specified agent.", "httpMethod": "GET", "id": "ces.projects.locations.apps.agents.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "location": "path" }, "updateMask": { "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "httpMethod": "PATCH", "request": { "$ref": "Agent" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}", "id": "ces.projects.locations.apps.agents.patch", "path": "v1/{+name}", "response": { "$ref": "Agent" }, "description": "Updates the specified agent." }, "list": { "parameters": { "parent": { "description": "Required. The resource name of the app to list agents from.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "pageSize": { "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListAgents call.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" }, "filter": { "description": "Optional. Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists agents in the given app.", "path": "v1/{+parent}/agents", "response": { "$ref": "ListAgentsResponse" }, "id": "ces.projects.locations.apps.agents.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents", "httpMethod": "GET" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "force": { "description": "Optional. Indicates whether to forcefully delete the agent, even if it is still referenced by other app/agents/examples. * If `force = false`, the deletion fails if other agents/examples reference it. * If `force = true`, delete the agent and remove it from all referencing apps/agents/examples.", "type": "boolean", "location": "query" }, "etag": { "location": "query", "description": "Optional. The current etag of the agent. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the agent, deletion will be blocked and an ABORTED error will be returned.", "type": "string" }, "name": { "description": "Required. The resource name of the agent to delete.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "location": "path" } }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}", "id": "ces.projects.locations.apps.agents.delete", "path": "v1/{+name}", "response": { "$ref": "Empty" }, "description": "Deletes the specified agent." }, "create": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to create an agent in.", "required": true, "type": "string" }, "agentId": { "location": "query", "description": "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.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "path": "v1/{+parent}/agents", "response": { "$ref": "Agent" }, "description": "Creates a new agent in the given app.", "httpMethod": "POST", "request": { "$ref": "Agent" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents", "id": "ces.projects.locations.apps.agents.create" } } }, "guardrails": { "methods": { "create": { "description": "Creates a new guardrail in the given app.", "path": "v1/{+parent}/guardrails", "response": { "$ref": "Guardrail" }, "id": "ces.projects.locations.apps.guardrails.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails", "request": { "$ref": "Guardrail" }, "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource name of the app to create a guardrail in.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "guardrailId": { "description": "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.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "id": "ces.projects.locations.apps.guardrails.delete", "httpMethod": "DELETE", "description": "Deletes the specified guardrail.", "path": "v1/{+name}", "response": { "$ref": "Empty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "force": { "location": "query", "description": "Optional. Indicates whether to forcefully delete the guardrail, even if it is still referenced by app/agents. * If `force = false`, the deletion fails if any apps/agents still reference the guardrail. * If `force = true`, all existing references from apps/agents will be removed and the guardrail will be deleted.", "type": "boolean" }, "etag": { "description": "Optional. The current etag of the guardrail. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the guardrail, deletion will be blocked and an ABORTED error will be returned.", "type": "string", "location": "query" }, "name": { "description": "Required. The resource name of the guardrail to delete.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "location": "path" } } }, "list": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "filter": { "location": "query", "description": "Optional. Filter to be applied when listing the guardrails. See https://google.aip.dev/160 for more details.", "type": "string" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListGuardrails call.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" }, "parent": { "description": "Required. The resource name of the app to list guardrails from.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "pageSize": { "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "format": "int32" } }, "id": "ces.projects.locations.apps.guardrails.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails", "httpMethod": "GET", "description": "Lists guardrails in the given app.", "path": "v1/{+parent}/guardrails", "response": { "$ref": "ListGuardrailsResponse" } }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "location": "path", "description": "Required. The resource name of the guardrail to retrieve.", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "Guardrail" }, "description": "Gets details of the specified guardrail.", "httpMethod": "GET", "id": "ces.projects.locations.apps.guardrails.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}" }, "patch": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "location": "path" }, "updateMask": { "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "id": "ces.projects.locations.apps.guardrails.patch", "httpMethod": "PATCH", "request": { "$ref": "Guardrail" }, "description": "Updates the specified guardrail.", "path": "v1/{+name}", "response": { "$ref": "Guardrail" } } } }, "examples": { "methods": { "list": { "description": "Lists examples in the given app.", "path": "v1/{+parent}/examples", "response": { "$ref": "ListExamplesResponse" }, "id": "ces.projects.locations.apps.examples.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples", "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListExamples call.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details.", "type": "string" }, "pageSize": { "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to list examples from.", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "id": "ces.projects.locations.apps.examples.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}", "path": "v1/{+name}", "response": { "$ref": "Example" }, "description": "Gets details of the specified example.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$", "location": "path", "description": "Required. The resource name of the example to retrieve.", "required": true, "type": "string" } } }, "patch": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$", "location": "path", "description": "Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "Example" }, "description": "Updates the specified example.", "request": { "$ref": "Example" }, "httpMethod": "PATCH", "id": "ces.projects.locations.apps.examples.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}" }, "create": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to create an example in.", "required": true, "type": "string" }, "exampleId": { "description": "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.", "type": "string", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples", "id": "ces.projects.locations.apps.examples.create", "httpMethod": "POST", "request": { "$ref": "Example" }, "description": "Creates a new example in the given app.", "path": "v1/{+parent}/examples", "response": { "$ref": "Example" } }, "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$", "location": "path", "description": "Required. The resource name of the example to delete.", "required": true, "type": "string" }, "etag": { "location": "query", "description": "Optional. The current etag of the example. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the example, deletion will be blocked and an ABORTED error will be returned.", "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes the specified example.", "path": "v1/{+name}", "response": { "$ref": "Empty" }, "id": "ces.projects.locations.apps.examples.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}", "httpMethod": "DELETE" } } }, "deployments": { "methods": { "get": { "path": "v1/{+name}", "response": { "$ref": "Deployment" }, "description": "Gets details of the specified deployment.", "httpMethod": "GET", "id": "ces.projects.locations.apps.deployments.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "parameters": { "name": { "description": "Required. The name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "patch": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "location": "path", "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "required": true, "type": "string" }, "updateMask": { "location": "query", "description": "Optional. The list of fields to update.", "type": "string", "format": "google-fieldmask" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "id": "ces.projects.locations.apps.deployments.patch", "httpMethod": "PATCH", "request": { "$ref": "Deployment" }, "description": "Updates the specified deployment.", "path": "v1/{+name}", "response": { "$ref": "Deployment" } }, "list": { "parameters": { "pageSize": { "location": "query", "description": "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.", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeployments` must match the call that provided the page token.", "type": "string" }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists deployments in the given app.", "path": "v1/{+parent}/deployments", "response": { "$ref": "ListDeploymentsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments", "id": "ces.projects.locations.apps.deployments.list", "httpMethod": "GET" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "etag": { "location": "query", "description": "Optional. The etag of the deployment. If an etag is provided and does not match the current etag of the deployment, deletion will be blocked and an ABORTED error will be returned.", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "location": "path", "description": "Required. The name of the deployment to delete. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "required": true, "type": "string" } }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "id": "ces.projects.locations.apps.deployments.delete", "path": "v1/{+name}", "response": { "$ref": "Empty" }, "description": "Deletes the specified deployment." }, "create": { "httpMethod": "POST", "request": { "$ref": "Deployment" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments", "id": "ces.projects.locations.apps.deployments.create", "path": "v1/{+parent}/deployments", "response": { "$ref": "Deployment" }, "description": "Creates a new deployment in the given app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "type": "string" }, "deploymentId": { "location": "query", "description": "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.", "type": "string" } } }, "getExtendedAgentCard": { "description": "Gets the extended agent card for the authenticated agent.", "path": "v1/{+tenant}/extendedAgentCard", "response": { "$ref": "LfA2aV1AgentCard" }, "id": "ces.projects.locations.apps.deployments.getExtendedAgentCard", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/extendedAgentCard", "httpMethod": "GET", "parameters": { "tenant": { "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "location": "path" } }, "parameterOrder": [ "tenant" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "message": { "methods": { "send": { "request": { "$ref": "LfA2aV1SendMessageRequest" }, "httpMethod": "POST", "id": "ces.projects.locations.apps.deployments.message.send", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/message:send", "path": "v1/{+tenant}/message:send", "response": { "$ref": "LfA2aV1SendMessageResponse" }, "description": "Sends a message to an agent.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "tenant" ], "parameters": { "tenant": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "location": "path", "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "required": true, "type": "string" } } } } } } }, "versions": { "methods": { "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "location": "path", "description": "Required. The resource name of the app version to delete.", "required": true, "type": "string" }, "etag": { "location": "query", "description": "Optional. The current etag of the app version. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app version, deletion will be blocked and an ABORTED error will be returned.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "Empty" }, "description": "Deletes the specified app version.", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}", "id": "ces.projects.locations.apps.versions.delete" }, "restore": { "path": "v1/{+name}:restore", "response": { "$ref": "Operation" }, "description": "Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version.", "request": { "$ref": "RestoreAppVersionRequest" }, "httpMethod": "POST", "id": "ces.projects.locations.apps.versions.restore", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}:restore", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "location": "path", "description": "Required. The resource name of the app version to restore.", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "create": { "id": "ces.projects.locations.apps.versions.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions", "request": { "$ref": "AppVersion" }, "httpMethod": "POST", "description": "Creates a new app version in the given app.", "path": "v1/{+parent}/versions", "response": { "$ref": "AppVersion" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to create an app version in.", "required": true, "type": "string" }, "appVersionId": { "location": "query", "description": "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.", "type": "string" } } }, "getExtendedAgentCard": { "parameters": { "tenant": { "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "location": "path" } }, "parameterOrder": [ "tenant" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the extended agent card for the authenticated agent.", "path": "v1/{+tenant}/extendedAgentCard", "response": { "$ref": "LfA2aV1AgentCard" }, "id": "ces.projects.locations.apps.versions.getExtendedAgentCard", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/extendedAgentCard", "httpMethod": "GET" }, "get": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The resource name of the app version to retrieve.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "location": "path" } }, "httpMethod": "GET", "id": "ces.projects.locations.apps.versions.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}", "path": "v1/{+name}", "response": { "$ref": "AppVersion" }, "description": "Gets details of the specified app version." }, "list": { "id": "ces.projects.locations.apps.versions.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions", "httpMethod": "GET", "description": "Lists all app versions in the given app.", "path": "v1/{+parent}/versions", "response": { "$ref": "ListAppVersionsResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListAppVersions call.", "type": "string" }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "Optional. Filter to be applied when listing the app versions. See https://google.aip.dev/160 for more details.", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "format": "int32", "location": "query" }, "parent": { "description": "Required. The resource name of the app to list app versions from.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } } } }, "resources": { "message": { "methods": { "send": { "description": "Sends a message to an agent.", "path": "v1/{+tenant}/message:send", "response": { "$ref": "LfA2aV1SendMessageResponse" }, "id": "ces.projects.locations.apps.versions.message.send", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/message:send", "request": { "$ref": "LfA2aV1SendMessageRequest" }, "httpMethod": "POST", "parameters": { "tenant": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "location": "path", "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "required": true, "type": "string" } }, "parameterOrder": [ "tenant" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "tools": { "methods": { "create": { "httpMethod": "POST", "request": { "$ref": "Tool" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools", "id": "ces.projects.locations.apps.tools.create", "path": "v1/{+parent}/tools", "response": { "$ref": "Tool" }, "description": "Creates a new tool in the given app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to create a tool in.", "required": true, "type": "string" }, "toolId": { "location": "query", "description": "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.", "type": "string" } } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "force": { "location": "query", "description": "Optional. Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples. * If `force = false`, the deletion will fail if any agents still reference the tool. * If `force = true`, all existing references from agents will be removed and the tool will be deleted.", "type": "boolean" }, "etag": { "location": "query", "description": "Optional. The current etag of the tool. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the tool, deletion will be blocked and an ABORTED error will be returned.", "type": "string" }, "name": { "description": "Required. The resource name of the tool to delete.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "location": "path" } }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "id": "ces.projects.locations.apps.tools.delete", "path": "v1/{+name}", "response": { "$ref": "Empty" }, "description": "Deletes the specified tool." }, "list": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to list tools from.", "required": true, "type": "string" }, "filter": { "description": "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.", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListTools call.", "type": "string" }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" } }, "httpMethod": "GET", "id": "ces.projects.locations.apps.tools.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools", "path": "v1/{+parent}/tools", "response": { "$ref": "ListToolsResponse" }, "description": "Lists tools in the given app." }, "get": { "httpMethod": "GET", "id": "ces.projects.locations.apps.tools.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "path": "v1/{+name}", "response": { "$ref": "Tool" }, "description": "Gets details of the specified tool.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "location": "path", "description": "Required. The resource name of the tool to retrieve.", "required": true, "type": "string" } } }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "id": "ces.projects.locations.apps.tools.patch", "httpMethod": "PATCH", "request": { "$ref": "Tool" }, "description": "Updates the specified tool.", "path": "v1/{+name}", "response": { "$ref": "Tool" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "location": "path", "description": "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.", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "type": "string", "format": "google-fieldmask", "location": "query" } } } } }, "changelogs": { "methods": { "list": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "description": "Required. The resource name of the app to list changelogs from.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "pageSize": { "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListChangelogs call.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" }, "filter": { "description": "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 \u003e \"2025-01-01T00:00:00Z\"` * `create_time \u003c= \"2025-01-01T00:00:00Z\" AND resource_type:tool`", "type": "string", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs", "id": "ces.projects.locations.apps.changelogs.list", "httpMethod": "GET", "description": "Lists the changelogs of the specified app.", "path": "v1/{+parent}/changelogs", "response": { "$ref": "ListChangelogsResponse" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/changelogs/[^/]+$", "location": "path", "description": "Required. The resource name of the changelog to retrieve.", "required": true, "type": "string" } }, "httpMethod": "GET", "id": "ces.projects.locations.apps.changelogs.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs/{changelogsId}", "path": "v1/{+name}", "response": { "$ref": "Changelog" }, "description": "Gets the specified changelog." } } }, "message": { "methods": { "send": { "description": "Sends a message to an agent.", "path": "v1/{+tenant}/message:send", "response": { "$ref": "LfA2aV1SendMessageResponse" }, "id": "ces.projects.locations.apps.message.send", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/message:send", "request": { "$ref": "LfA2aV1SendMessageRequest" }, "httpMethod": "POST", "parameters": { "tenant": { "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "parameterOrder": [ "tenant" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] } } }, "sessions": { "methods": { "streamRunSession": { "parameterOrder": [ "session" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "session": { "description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "location": "path" } }, "id": "ces.projects.locations.apps.sessions.streamRunSession", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:streamRunSession", "request": { "$ref": "RunSessionRequest" }, "httpMethod": "POST", "description": "Initiates a single-turn interaction with the CES agent. Uses server-side streaming to deliver incremental results and partial responses as they are generated. By default, complete responses (e.g., messages from callbacks or full LLM responses) are sent to the client as soon as they are available. To enable streaming individual text chunks directly from the model, set enable_text_streaming to true.", "path": "v1/{+session}:streamRunSession", "response": { "$ref": "RunSessionResponse" } }, "runSession": { "parameters": { "session": { "description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "location": "path" } }, "parameterOrder": [ "session" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Initiates a single-turn interaction with the CES agent within a session.", "path": "v1/{+session}:runSession", "response": { "$ref": "RunSessionResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:runSession", "id": "ces.projects.locations.apps.sessions.runSession", "httpMethod": "POST", "request": { "$ref": "RunSessionRequest" } }, "generateChatToken": { "parameters": { "name": { "description": "Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "location": "path" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Generates a session scoped token for chat widget to authenticate with Session APIs.", "path": "v1/{+name}:generateChatToken", "response": { "$ref": "GenerateChatTokenResponse" }, "id": "ces.projects.locations.apps.sessions.generateChatToken", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:generateChatToken", "request": { "$ref": "GenerateChatTokenRequest" }, "httpMethod": "POST" } } } } } } } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "schemas": { "LfA2aV1AgentCardSignature": { "properties": { "protected": { "description": "Required. Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object.", "type": "string" }, "signature": { "description": "Required. The computed signature, base64url-encoded.", "type": "string" }, "header": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The unprotected JWS header values.", "type": "object" } }, "id": "LfA2aV1AgentCardSignature", "description": "AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).", "type": "object" }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds": { "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds", "description": "Expectation level metrics thresholds.", "type": "object", "properties": { "toolInvocationParameterCorrectnessThreshold": { "description": "Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.", "type": "number", "format": "float" } } }, "RemoteAgentTool": { "properties": { "agentCard": { "description": "Required. The agent card of the remote agent that this tool invokes.", "$ref": "AgentCard" }, "name": { "description": "Required. The name of the tool.", "type": "string" }, "description": { "description": "Required. The description of the tool.", "type": "string" } }, "id": "RemoteAgentTool", "description": "Represents a tool that allows the agent to call another remote agent.", "type": "object" }, "AgentCard": { "properties": { "name": { "description": "Required. A human-readable name for the agent.", "type": "string" }, "description": { "description": "Required. A description of the agent's domain of action/solution space.", "type": "string" }, "supportedInterfaces": { "items": { "$ref": "AgentInterface" }, "description": "Required. Ordered list of supported interfaces. The first entry is preferred.", "type": "array" }, "skills": { "items": { "$ref": "AgentSkill" }, "description": "Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.", "type": "array" }, "version": { "description": "Required. The version of the agent.", "type": "string" } }, "id": "AgentCard", "description": "AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard", "type": "object" }, "AgentTool": { "properties": { "name": { "description": "Required. The name of the agent tool.", "type": "string" }, "description": { "description": "Optional. Description of the tool's purpose.", "type": "string" }, "agent": { "description": "Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", "type": "string" } }, "id": "AgentTool", "description": "Represents a tool that allows the agent to call another agent.", "type": "object" }, "LfA2aV1SecurityRequirement": { "id": "LfA2aV1SecurityRequirement", "description": "Defines the security requirements for an agent.", "type": "object", "properties": { "schemes": { "description": "A map of security schemes to the required scopes.", "type": "object", "additionalProperties": { "$ref": "LfA2aV1StringList" } } } }, "LfA2aV1StringList": { "id": "LfA2aV1StringList", "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.", "type": "object", "properties": { "list": { "description": "The individual string values.", "type": "array", "items": { "type": "string" } } } }, "ListConversationsResponse": { "id": "ListConversationsResponse", "description": "Response message for AgentService.ListConversations.", "type": "object", "properties": { "nextPageToken": { "description": "A token that can be sent as ListConversationsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" }, "conversations": { "items": { "$ref": "Conversation" }, "description": "The list of conversations.", "type": "array" } } }, "GoogleSearchTool": { "properties": { "contextUrls": { "description": "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.", "type": "array", "items": { "type": "string" } }, "excludeDomains": { "description": "Optional. List of domains to be excluded from the search results. Example: \"example.com\". A maximum of 2000 domains can be excluded.", "type": "array", "items": { "type": "string" } }, "promptConfig": { "description": "Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.", "$ref": "GoogleSearchToolPromptConfig" }, "name": { "description": "Required. The name of the tool.", "type": "string" }, "description": { "description": "Optional. Description of the tool's purpose.", "type": "string" }, "preferredDomains": { "items": { "type": "string" }, "description": "Optional. Specifies domains to restrict search results to. Example: \"example.com\", \"another.site\". A maximum of 20 domains can be specified.", "type": "array" } }, "id": "GoogleSearchTool", "description": "Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.", "type": "object" }, "EndpointControlPolicy": { "id": "EndpointControlPolicy", "description": "Defines project/location level endpoint control policy.", "type": "object", "properties": { "enforcementScope": { "enumDescriptions": [ "Unspecified. This policy will be treated as VPCSC_ONLY.", "This policy applies only when VPC-SC is active.", "This policy ALWAYS applies, regardless of VPC-SC status." ], "description": "Optional. The scope in which this policy's allowed_origins list is enforced.", "type": "string", "enum": [ "ENFORCEMENT_SCOPE_UNSPECIFIED", "VPCSC_ONLY", "ALWAYS" ] }, "allowedOrigins": { "items": { "type": "string" }, "description": "Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, \"https://example.com\" will match \"https://example.com:443\" and any other port. \"https://example.com:443\" will only match \"https://example.com:443\".", "type": "array" } } }, "GuardrailModelSafetySafetySetting": { "id": "GuardrailModelSafetySafetySetting", "description": "Safety setting.", "type": "object", "properties": { "category": { "enumDescriptions": [ "The harm category is unspecified.", "The harm category is hate speech.", "The harm category is dangerous content.", "The harm category is harassment.", "The harm category is sexually explicit content." ], "description": "Required. The harm category.", "type": "string", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT" ] }, "threshold": { "description": "Required. The harm block threshold.", "type": "string", "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", "BLOCK_NONE", "OFF" ], "enumDescriptions": [ "Unspecified harm block threshold.", "Block low threshold and above (i.e. block more).", "Block medium threshold and above.", "Block only high threshold (i.e. block less).", "Block none.", "Turn off the safety filter." ] } } }, "Blob": { "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" }, "data": { "description": "Required. Raw bytes of the blob.", "type": "string", "format": "byte" } }, "id": "Blob", "description": "Represents a blob input or output in the conversation.", "type": "object" }, "EndSession": { "properties": { "metadata": { "description": "Optional. Provides additional information about the end session signal, such as the reason for ending the session.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "id": "EndSession", "description": "Indicates the session has terminated, due to either successful completion (e.g. user says \"Good bye!\" ) or an agent escalation. The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent.", "type": "object" }, "AudioRecordingConfig": { "id": "AudioRecordingConfig", "description": "Configuration for how the audio interactions should be recorded.", "type": "object", "properties": { "gcsBucket": { "description": "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`.", "type": "string" }, "gcsPathPrefix": { "description": "Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.", "type": "string" } } }, "ToolCalls": { "properties": { "toolCalls": { "items": { "$ref": "ToolCall" }, "description": "Optional. The list of tool calls to execute.", "type": "array" } }, "id": "ToolCalls", "description": "Request for the client to execute the tools and return the execution results before continuing the session.", "type": "object" }, "Location": { "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object" } }, "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object" }, "ListExamplesResponse": { "properties": { "examples": { "description": "The list of examples.", "type": "array", "items": { "$ref": "Example" } }, "nextPageToken": { "description": "A token that can be sent as ListExamplesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } }, "id": "ListExamplesResponse", "description": "Response message for AgentService.ListExamples.", "type": "object" }, "AppSnapshot": { "properties": { "tools": { "description": "Optional. List of tools in the app.", "type": "array", "items": { "$ref": "Tool" } }, "toolsets": { "items": { "$ref": "Toolset" }, "description": "Optional. List of toolsets in the app.", "type": "array" }, "app": { "description": "Optional. The basic settings for the app.", "$ref": "App" }, "agents": { "description": "Optional. List of agents in the app.", "type": "array", "items": { "$ref": "Agent" } }, "guardrails": { "description": "Optional. List of guardrails in the app.", "type": "array", "items": { "$ref": "Guardrail" } }, "examples": { "items": { "$ref": "Example" }, "description": "Optional. List of examples in the app.", "type": "array" } }, "id": "AppSnapshot", "description": "A snapshot of the app.", "type": "object" }, "ConnectorTool": { "properties": { "action": { "description": "Required. Action for the tool to use.", "$ref": "Action" }, "authConfig": { "description": "Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.", "$ref": "EndUserAuthConfig" }, "name": { "description": "Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.", "type": "string" }, "description": { "description": "Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.", "type": "string" }, "connection": { "description": "Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`", "type": "string" } }, "id": "ConnectorTool", "description": "A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview.", "type": "object" }, "LfA2aV1ClientCredentialsOAuthFlow": { "id": "LfA2aV1ClientCredentialsOAuthFlow", "description": "Defines configuration details for the OAuth 2.0 Client Credentials flow.", "type": "object", "properties": { "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Required. The available scopes for the OAuth2 security scheme.", "type": "object" }, "tokenUrl": { "description": "Required. The token URL to be used for this flow.", "type": "string" } } }, "GuardrailCodeCallback": { "id": "GuardrailCodeCallback", "description": "Guardrail that blocks the conversation based on the code callbacks provided.", "type": "object", "properties": { "beforeModelCallback": { "description": "Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.", "$ref": "Callback" }, "beforeAgentCallback": { "description": "Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.", "$ref": "Callback" }, "afterAgentCallback": { "description": "Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.", "$ref": "Callback" }, "afterModelCallback": { "description": "Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.", "$ref": "Callback" } } }, "AgentSkill": { "id": "AgentSkill", "description": "Represents a distinct capability or function that an agent can perform.", "type": "object", "properties": { "id": { "description": "Required. A unique identifier for the agent's skill.", "type": "string" }, "tags": { "description": "Required. A set of keywords describing the skill's capabilities.", "type": "array", "items": { "type": "string" } }, "name": { "description": "Required. A human-readable name for the skill.", "type": "string" }, "description": { "description": "Required. A detailed description of the skill.", "type": "string" }, "examples": { "items": { "type": "string" }, "description": "Example prompts or scenarios that this skill can handle.", "type": "array" }, "inputModes": { "description": "The set of supported input media types for this skill, overriding the agent's defaults.", "type": "array", "items": { "type": "string" } }, "outputModes": { "items": { "type": "string" }, "description": "The set of supported output media types for this skill, overriding the agent's defaults.", "type": "array" } } }, "ImportAppResponse": { "id": "ImportAppResponse", "description": "Response message for AgentService.ImportApp.", "type": "object", "properties": { "name": { "description": "The resource name of the app that was imported.", "type": "string" }, "warnings": { "description": "Warning messages generated during the import process. If errors occur for specific resources, they will not be included in the imported app and the error will be mentioned here.", "type": "array", "items": { "type": "string" } } } }, "ExecuteToolResponse": { "properties": { "googleSearchSuggestions": { "description": "The suggestions returned from Google Search as a result of invoking the Google Search Tool during the tool execution.", "$ref": "GoogleSearchSuggestions" }, "tool": { "description": "The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "response": { "description": "The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "toolsetTool": { "description": "The toolset tool that got executed.", "$ref": "ToolsetTool" }, "variables": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The variable values at the end of the tool execution.", "type": "object" }, "citations": { "description": "Citations that provide the source information for the tool's execution.", "$ref": "Citations" } }, "id": "ExecuteToolResponse", "description": "Response message for ToolService.ExecuteTool.", "type": "object" }, "ListAgentsResponse": { "properties": { "agents": { "items": { "$ref": "Agent" }, "description": "The list of agents.", "type": "array" }, "nextPageToken": { "description": "A token that can be sent as ListAgentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } }, "id": "ListAgentsResponse", "description": "Response message for AgentService.ListAgents.", "type": "object" }, "Schema": { "id": "Schema", "description": "Represents a select subset of an OpenAPI 3.0 schema object.", "type": "object", "properties": { "default": { "description": "Optional. Default value of the data.", "type": "any" }, "type": { "description": "Required. The type of the data.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "STRING", "INTEGER", "NUMBER", "BOOLEAN", "OBJECT", "ARRAY" ], "enumDescriptions": [ "Type unspecified.", "String type.", "Integer type.", "Number type.", "Boolean type.", "Object type.", "Array type." ] }, "maxItems": { "description": "Optional. Maximum number of the elements for Type.ARRAY.", "type": "string", "format": "int64" }, "title": { "description": "Optional. The title of the schema.", "type": "string" }, "additionalProperties": { "description": "Optional. Can either be a boolean or an object, controls the presence of additional properties.", "$ref": "Schema" }, "defs": { "description": "Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.", "type": "object", "additionalProperties": { "$ref": "Schema" } }, "minimum": { "description": "Optional. Minimum value for Type.INTEGER and Type.NUMBER.", "type": "number", "format": "double" }, "enum": { "items": { "type": "string" }, "description": "Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}", "type": "array" }, "maximum": { "description": "Optional. Maximum value for Type.INTEGER and Type.NUMBER.", "type": "number", "format": "double" }, "required": { "description": "Optional. Required properties of Type.OBJECT.", "type": "array", "items": { "type": "string" } }, "description": { "description": "Optional. The description of the data.", "type": "string" }, "anyOf": { "items": { "$ref": "Schema" }, "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", "type": "array" }, "minItems": { "description": "Optional. Minimum number of the elements for Type.ARRAY.", "type": "string", "format": "int64" }, "nullable": { "description": "Optional. Indicates if the value may be null.", "type": "boolean" }, "items": { "description": "Optional. Schema of the elements of Type.ARRAY.", "$ref": "Schema" }, "uniqueItems": { "description": "Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.", "type": "boolean" }, "ref": { "description": "Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named \"Pet\": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the \"pet\" property is a reference to the schema node named \"Pet\". See details in https://json-schema.org/understanding-json-schema/structuring.", "type": "string" }, "prefixItems": { "items": { "$ref": "Schema" }, "description": "Optional. Schemas of initial elements of Type.ARRAY.", "type": "array" }, "properties": { "additionalProperties": { "$ref": "Schema" }, "description": "Optional. Properties of Type.OBJECT.", "type": "object" } } }, "LfA2aV1Task": { "properties": { "id": { "description": "Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task.", "type": "string" }, "contextId": { "description": "Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages).", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.", "type": "object" }, "status": { "description": "Required. The current status of a `Task`, including `state` and a `message`.", "$ref": "LfA2aV1TaskStatus" }, "history": { "items": { "$ref": "LfA2aV1Message" }, "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`.", "type": "array" }, "artifacts": { "items": { "$ref": "LfA2aV1Artifact" }, "description": "A set of output artifacts for a `Task`.", "type": "array" } }, "id": "LfA2aV1Task", "description": "`Task` is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.", "type": "object" }, "ExperimentConfigVersionRelease": { "properties": { "state": { "enumDescriptions": [ "Unspecified state.", "Deprecated: This state is no longer used.", "Running state. Experiment is running and valid.", "Deprecated: This state is no longer used.", "Deprecated: This state is no longer used." ], "description": "Optional. State of the version release.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "DONE", "EXPIRED" ] }, "trafficAllocations": { "description": "Optional. Traffic allocations for the version release.", "type": "array", "items": { "$ref": "ExperimentConfigVersionReleaseTrafficAllocation" } } }, "id": "ExperimentConfigVersionRelease", "description": "Version release for the experiment.", "type": "object" }, "Status": { "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "id": "Status", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object" }, "TransferRule": { "id": "TransferRule", "description": "Rule for transferring to a specific agent.", "type": "object", "properties": { "deterministicTransfer": { "description": "Optional. A rule that immediately transfers to the target agent when the condition is met.", "$ref": "TransferRuleDeterministicTransfer" }, "childAgent": { "description": "Required. The resource name of the child agent the rule applies to. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "direction": { "enumDescriptions": [ "Unspecified direction.", "Transfer from the parent agent to the child agent.", "Transfer from the child agent to the parent agent." ], "description": "Required. The direction of the transfer.", "type": "string", "enum": [ "DIRECTION_UNSPECIFIED", "PARENT_TO_CHILD", "CHILD_TO_PARENT" ] }, "disablePlannerTransfer": { "description": "Optional. Rule that prevents the planner from transferring to the target agent.", "$ref": "TransferRuleDisablePlannerTransfer" } } }, "DataStoreSettingsEngine": { "id": "DataStoreSettingsEngine", "description": "An engine to which the data stores are connected. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.", "type": "object", "properties": { "name": { "description": "Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "readOnly": true, "type": "string" }, "type": { "enum": [ "TYPE_UNSPECIFIED", "ENGINE_TYPE_SEARCH", "ENGINE_TYPE_CHAT" ], "enumDescriptions": [ "Unspecified engine type.", "The SOLUTION_TYPE_SEARCH engine for the app. All connector data stores added to the app will be added to this engine.", "Chat engine type. The SOLUTION_TYPE_CHAT engine for the app. All connector data stores added to the app will be added to this engine." ], "description": "Output only. The type of the engine.", "readOnly": true, "type": "string" } } }, "WhatsAppCredentials": { "properties": { "conversationProfileId": { "description": "Optional. The Conversation Profile ID to use for the deployment.", "type": "string" }, "phoneNumber": { "description": "Required. The phone number to register with WhatsApp.", "type": "string" }, "businessAccountId": { "description": "Required. The Business Account ID to use for the phone number.", "type": "string" }, "authCode": { "description": "Required. The Meta auth code provided by the embedded signup flow.", "type": "string" }, "wabaId": { "description": "Required. The WhatsApp Business Account ID.", "type": "string" }, "pin": { "description": "Required. The 6-digit PIN created by the user for two-step verification.", "type": "string" } }, "id": "WhatsAppCredentials", "description": "Ephemeral Meta credentials for WhatsApp native integration.", "type": "object" }, "ExpressionCondition": { "properties": { "expression": { "description": "Required. The string representation of cloud.api.Expression condition.", "type": "string" } }, "id": "ExpressionCondition", "description": "Expression condition based on session state.", "type": "object" }, "DataStoreToolSnippetsConfig": { "id": "DataStoreToolSnippetsConfig", "description": "Snippets configuration.", "type": "object", "properties": { "enableSnippets": { "description": "Optional. Whether snippets are enabled.", "type": "boolean" } } }, "Action": { "properties": { "inputFields": { "description": "Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.", "type": "array", "items": { "type": "string" } }, "connectionActionId": { "description": "ID of a Connection action for the tool to use.", "type": "string" }, "entityOperation": { "description": "Entity operation configuration for the tool to use.", "$ref": "ActionEntityOperation" }, "outputFields": { "items": { "type": "string" }, "description": "Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.", "type": "array" } }, "id": "Action", "description": "Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details.", "type": "object" }, "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec": { "id": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec", "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", "type": "object", "properties": { "fieldName": { "description": "Optional. The name of the field whose value will be used to determine the boost amount.", "type": "string" }, "interpolationType": { "enumDescriptions": [ "Interpolation type is unspecified. In this case, it defaults to Linear.", "Piecewise linear interpolation will be applied." ], "description": "Optional. The interpolation type to be applied to connect the control points listed below.", "type": "string", "enum": [ "INTERPOLATION_TYPE_UNSPECIFIED", "LINEAR" ] }, "controlPoints": { "description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", "type": "array", "items": { "$ref": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint" } }, "attributeType": { "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", "type": "string", "enum": [ "ATTRIBUTE_TYPE_UNSPECIFIED", "NUMERICAL", "FRESHNESS" ], "enumDescriptions": [ "Unspecified AttributeType.", "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. E.g. `5D`, `3DT12H30M`, `T24H`." ] } } }, "TransferRuleDisablePlannerTransfer": { "properties": { "expressionCondition": { "description": "Required. If the condition evaluates to true, planner will not be allowed to transfer to the target agent.", "$ref": "ExpressionCondition" } }, "id": "TransferRuleDisablePlannerTransfer", "description": "A rule that prevents the planner from transferring to the target agent.", "type": "object" }, "ChannelProfileWhatsAppConfig": { "id": "ChannelProfileWhatsAppConfig", "description": "Configuration specific to WhatsApp deployments.", "type": "object", "properties": { "wabaId": { "description": "Required. The WhatsApp Business Account ID.", "type": "string" }, "phoneNumberId": { "description": "Required. The Meta phone number ID.", "type": "string" }, "displayName": { "description": "Output only. The fetched Meta business page name.", "readOnly": true, "type": "string" }, "thumbnailUrl": { "description": "Output only. The fetched Meta business profile thumbnail URL.", "readOnly": true, "type": "string" }, "phoneNumber": { "description": "Optional. The phone number in E.164 format.", "type": "string" }, "description": { "description": "Output only. The description of the Meta business page or profile.", "readOnly": true, "type": "string" } } }, "Changelog": { "properties": { "originalResource": { "description": "Output only. The original resource before the change.", "readOnly": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "description": { "description": "Output only. Description of the change. which typically captures the changed fields in the resource.", "readOnly": true, "type": "string" }, "resource": { "description": "Output only. The resource that was changed.", "readOnly": true, "type": "string" }, "resourceType": { "description": "Output only. The type of the resource that was changed.", "readOnly": true, "type": "string" }, "displayName": { "description": "Output only. Display name of the change. It typically should be the display name of the resource that was changed.", "readOnly": true, "type": "string" }, "sequenceNumber": { "description": "Output only. The monotonically increasing sequence number of the changelog.", "readOnly": true, "type": "string", "format": "int64" }, "author": { "description": "Output only. Email address of the change author.", "readOnly": true, "type": "string" }, "action": { "description": "Output only. The action that was performed on the resource.", "readOnly": true, "type": "string" }, "dependentResources": { "description": "Output only. The dependent resources that were changed.", "readOnly": true, "type": "array", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "name": { "description": "Identifier. The unique identifier of the changelog. Format: `projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}`", "type": "string" }, "createTime": { "description": "Output only. The time when the change was made.", "readOnly": true, "type": "string", "format": "google-datetime" }, "newResource": { "description": "Output only. The new resource after the change.", "readOnly": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "id": "Changelog", "description": "Changelogs represent a change made to the app or to an resource within the app.", "type": "object" }, "WebSearchQuery": { "id": "WebSearchQuery", "description": "Represents a single web search query and its associated search uri.", "type": "object", "properties": { "query": { "description": "The search query text.", "type": "string" }, "uri": { "description": "The URI to the Google Search results page for the query.", "type": "string" } } }, "DataStoreToolDataStoreSource": { "id": "DataStoreToolDataStoreSource", "description": "Configuration for searching within a specific DataStore.", "type": "object", "properties": { "filter": { "description": "Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata", "type": "string" }, "dataStore": { "description": "Optional. The data store.", "$ref": "DataStore" } } }, "ModelSettings": { "properties": { "temperature": { "description": "Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.", "type": "number", "format": "double" }, "model": { "description": "Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.", "type": "string" } }, "id": "ModelSettings", "description": "Model settings contains various configurations for the LLM model.", "type": "object" }, "Toolset": { "id": "Toolset", "description": "A toolset represents a group of dynamically managed tools that can be used by the agent.", "type": "object", "properties": { "connectorToolset": { "description": "Optional. A toolset that generates tools from an Integration Connectors Connection.", "$ref": "ConnectorToolset" }, "name": { "description": "Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string" }, "timeout": { "description": "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.", "type": "string", "format": "google-duration" }, "openApiToolset": { "description": "Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema.", "$ref": "OpenApiToolset" }, "executionType": { "description": "Optional. The execution type of the tools in the toolset.", "type": "string", "enum": [ "EXECUTION_TYPE_UNSPECIFIED", "SYNCHRONOUS", "ASYNCHRONOUS" ], "enumDescriptions": [ "The execution type is unspecified. Defaults to `SYNCHRONOUS` if unspecified.", "The tool is executed synchronously. The session is blocked until the tool returns.", "The tool is executed asynchronously. The session will continue while the tool is executing." ] }, "createTime": { "description": "Output only. Timestamp when the toolset was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "etag": { "description": "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.", "type": "string" }, "description": { "description": "Optional. The description of the toolset.", "type": "string" }, "mcpToolset": { "description": "Optional. A toolset that contains a list of tools that are offered by the MCP server.", "$ref": "McpToolset" }, "displayName": { "description": "Optional. The display name of the toolset. Must be unique within the same app.", "type": "string" }, "toolFakeConfig": { "description": "Optional. Configuration for tools behavior in fake mode.", "$ref": "ToolFakeConfig" }, "updateTime": { "description": "Output only. Timestamp when the toolset was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "Citations": { "properties": { "citedChunks": { "items": { "$ref": "CitationsCitedChunk" }, "description": "List of cited pieces of information.", "type": "array" } }, "id": "Citations", "description": "Citations associated with the agent response.", "type": "object" }, "DataStoreConnectorConfig": { "id": "DataStoreConnectorConfig", "description": "The connector config for the data store connection.", "type": "object", "properties": { "collectionDisplayName": { "description": "Display name of the collection the data store belongs to.", "type": "string" }, "collection": { "description": "Resource name of the collection the data store belongs to.", "type": "string" }, "dataSource": { "description": "The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.", "type": "string" } } }, "DataStoreToolModalityConfig": { "properties": { "snippetsConfig": { "description": "Optional. The snippets configuration.", "$ref": "DataStoreToolSnippetsConfig" }, "groundingConfig": { "description": "Optional. The grounding configuration.", "$ref": "DataStoreToolGroundingConfig" }, "modalityType": { "enumDescriptions": [ "Unspecified modality type.", "Text modality.", "Audio modality." ], "description": "Required. The modality type.", "type": "string", "enum": [ "MODALITY_TYPE_UNSPECIFIED", "TEXT", "AUDIO" ] }, "summarizationConfig": { "description": "Optional. The summarization config.", "$ref": "DataStoreToolSummarizationConfig" }, "rewriterConfig": { "description": "Optional. The rewriter config.", "$ref": "DataStoreToolRewriterConfig" } }, "id": "DataStoreToolModalityConfig", "description": "If specified, will apply the given configuration for the specified modality.", "type": "object" }, "TriggerAction": { "id": "TriggerAction", "description": "Action that is taken when a certain precondition is met.", "type": "object", "properties": { "transferAgent": { "description": "Optional. Transfer the conversation to a different agent.", "$ref": "TriggerActionTransferAgent" }, "respondImmediately": { "description": "Optional. Immediately respond with a preconfigured response.", "$ref": "TriggerActionRespondImmediately" }, "generativeAnswer": { "description": "Optional. Respond with a generative answer.", "$ref": "TriggerActionGenerativeAnswer" } } }, "ListAppsResponse": { "properties": { "nextPageToken": { "description": "A token that can be sent as ListAppsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" }, "unreachable": { "description": "Unordered list. Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "apps": { "items": { "$ref": "App" }, "description": "The list of apps.", "type": "array" } }, "id": "ListAppsResponse", "description": "Response message for AgentService.ListApps.", "type": "object" }, "ExportAppResponse": { "id": "ExportAppResponse", "description": "Response message for AgentService.ExportApp.", "type": "object", "properties": { "appUri": { "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which the app was exported.", "type": "string" }, "appContent": { "description": "App folder compressed as a zip file.", "type": "string", "format": "byte" } } }, "LfA2aV1AgentCapabilities": { "properties": { "streaming": { "description": "Indicates if the agent supports streaming responses.", "type": "boolean" }, "pushNotifications": { "description": "Indicates if the agent supports sending push notifications for asynchronous task updates.", "type": "boolean" }, "extendedAgentCard": { "description": "Indicates if the agent supports providing an extended agent card when authenticated.", "type": "boolean" }, "extensions": { "description": "A list of protocol extensions supported by the agent.", "type": "array", "items": { "$ref": "LfA2aV1AgentExtension" } } }, "id": "LfA2aV1AgentCapabilities", "description": "Defines optional capabilities supported by an agent.", "type": "object" }, "OpenApiTool": { "id": "OpenApiTool", "description": "A remote API tool defined by an OpenAPI schema.", "type": "object", "properties": { "openApiSchema": { "description": "Required. The OpenAPI schema in JSON or YAML format.", "type": "string" }, "name": { "description": "Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.", "type": "string" }, "description": { "description": "Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.", "type": "string" }, "apiAuthentication": { "description": "Optional. Authentication information required by the API.", "$ref": "ApiAuthentication" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates that the client will trust.", "$ref": "TlsConfig" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration.", "$ref": "ServiceDirectoryConfig" }, "ignoreUnknownFields": { "description": "Optional. If true, the agent will ignore unknown fields in the API response.", "type": "boolean" }, "url": { "description": "Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.", "type": "string" } } }, "LfA2aV1TaskStatus": { "id": "LfA2aV1TaskStatus", "description": "A container for the status of a task", "type": "object", "properties": { "state": { "description": "Required. The current state of this task.", "type": "string", "enum": [ "TASK_STATE_UNSPECIFIED", "TASK_STATE_SUBMITTED", "TASK_STATE_WORKING", "TASK_STATE_COMPLETED", "TASK_STATE_FAILED", "TASK_STATE_CANCELED", "TASK_STATE_INPUT_REQUIRED", "TASK_STATE_REJECTED", "TASK_STATE_AUTH_REQUIRED" ], "enumDescriptions": [ "The task is in an unknown or indeterminate state.", "Indicates that a task has been successfully submitted and acknowledged.", "Indicates that a task is actively being processed by the agent.", "Indicates that a task has finished successfully. This is a terminal state.", "Indicates that a task has finished with an error. This is a terminal state.", "Indicates that a task was canceled before completion. This is a terminal state.", "Indicates that the agent requires additional user input to proceed. This is an interrupted state.", "Indicates that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", "Indicates that authentication is required to proceed. This is an interrupted state." ] }, "message": { "description": "A message associated with the status.", "$ref": "LfA2aV1Message" }, "timestamp": { "description": "ISO 8601 Timestamp when the status was recorded. Example: \"2023-10-27T10:00:00Z\"", "type": "string", "format": "google-datetime" } } }, "CloudLoggingSettings": { "properties": { "enableCloudLogging": { "description": "Optional. Whether to enable Cloud Logging for the sessions.", "type": "boolean" } }, "id": "CloudLoggingSettings", "description": "Settings to describe the Cloud Logging behaviors for the app.", "type": "object" }, "BatchDeleteConversationsRequest": { "properties": { "conversations": { "items": { "type": "string" }, "description": "Required. The resource names of the conversations to delete.", "type": "array" } }, "id": "BatchDeleteConversationsRequest", "description": "Request message for AgentService.BatchDeleteConversations.", "type": "object" }, "LfA2aV1AgentProvider": { "properties": { "url": { "description": "Required. A URL for the agent provider's website or relevant documentation. Example: \"https://ai.google.dev\"", "type": "string" }, "organization": { "description": "Required. The name of the agent provider's organization. Example: \"Google\"", "type": "string" } }, "id": "LfA2aV1AgentProvider", "description": "Represents the service provider of an agent.", "type": "object" }, "MetricAnalysisSettings": { "properties": { "llmMetricsOptedOut": { "description": "Optional. Whether to collect conversation data for llm analysis metrics. If true, conversation data will not be collected for llm analysis metrics; otherwise, conversation data will be collected.", "type": "boolean" } }, "id": "MetricAnalysisSettings", "description": "Settings to describe the conversation data collection behaviors for LLM analysis metrics pipeline.", "type": "object" }, "ActionEntityOperation": { "properties": { "entityId": { "description": "Required. ID of the entity.", "type": "string" }, "operation": { "enumDescriptions": [ "Operation type unspecified. Invalid, ConnectorTool create/update will fail.", "List operation.", "Get operation.", "Create operation.", "Update operation.", "Delete operation." ], "description": "Required. Operation to perform on the entity.", "type": "string", "enum": [ "OPERATION_TYPE_UNSPECIFIED", "LIST", "GET", "CREATE", "UPDATE", "DELETE" ] } }, "id": "ActionEntityOperation", "description": "Entity CRUD operation specification.", "type": "object" }, "AudioProcessingConfig": { "properties": { "synthesizeSpeechConfigs": { "additionalProperties": { "$ref": "SynthesizeSpeechConfig" }, "description": "Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains \"en-us\" and \"en\", and the specified language code is \"en-gb\", then \"en\" configuration will be used. Note: Language code is case-insensitive.", "type": "object" }, "bargeInConfig": { "description": "Optional. Configures the agent behavior for the user barge-in activities.", "$ref": "BargeInConfig" }, "ambientSoundConfig": { "description": "Optional. Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.", "$ref": "AmbientSoundConfig" }, "inactivityTimeout": { "description": "Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.", "type": "string", "format": "google-duration" } }, "id": "AudioProcessingConfig", "description": "Configuration for how the input and output audio should be processed and delivered.", "type": "object" }, "PythonFunction": { "properties": { "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration for the tool.", "$ref": "ServiceDirectoryConfig" }, "pythonCode": { "description": "Optional. The Python code to execute for the tool.", "type": "string" }, "name": { "description": "Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.", "type": "string" }, "description": { "description": "Output only. The description of the Python function, parsed from the python code's docstring.", "readOnly": true, "type": "string" } }, "id": "PythonFunction", "description": "A Python function tool.", "type": "object" }, "SessionConfig": { "properties": { "inputAudioConfig": { "description": "Optional. Configuration for processing the input audio.", "$ref": "InputAudioConfig" }, "remoteDialogflowQueryParameters": { "description": "Optional. [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters) to send to the remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent when the session control is transferred to the remote agent.", "$ref": "SessionConfigRemoteDialogflowQueryParameters" }, "excludeDiagnosticInfo": { "description": "Optional. Whether to exclude diagnostic info from the session output.", "type": "boolean" }, "deployment": { "description": "Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" }, "historicalContexts": { "description": "Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.", "type": "array", "items": { "$ref": "Message" } }, "useToolFakes": { "description": "Optional. Whether to use tool fakes for the session. If this field is set, the agent will attempt use tool fakes instead of calling the real tools.", "type": "boolean" }, "entryAgent": { "description": "Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "timeZone": { "description": "Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. \"America/Los_Angeles\".", "type": "string" }, "enableTextStreaming": { "description": "Optional. Whether to enable streaming text outputs from the model. By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession.", "type": "boolean" }, "outputAudioConfig": { "description": "Optional. Configuration for generating the output audio.", "$ref": "OutputAudioConfig" } }, "id": "SessionConfig", "description": "The configuration for the session.", "type": "object" }, "Guardrail": { "properties": { "createTime": { "description": "Output only. Timestamp when the guardrail was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "modelSafety": { "description": "Optional. Guardrail that blocks the conversation if the LLM response is considered unsafe based on the model safety settings.", "$ref": "GuardrailModelSafety" }, "codeCallback": { "description": "Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution.", "$ref": "GuardrailCodeCallback" }, "action": { "description": "Optional. Action to take when the guardrail is triggered.", "$ref": "TriggerAction" }, "description": { "description": "Optional. Description of the guardrail.", "type": "string" }, "displayName": { "description": "Required. Display name of the guardrail.", "type": "string" }, "enabled": { "description": "Optional. Whether the guardrail is enabled.", "type": "boolean" }, "etag": { "description": "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.", "type": "string" }, "name": { "description": "Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "type": "string" }, "contentFilter": { "description": "Optional. Guardrail that bans certain content from being used in the conversation.", "$ref": "GuardrailContentFilter" }, "llmPolicy": { "description": "Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.", "$ref": "GuardrailLlmPolicy" }, "llmPromptSecurity": { "description": "Optional. Guardrail that blocks the conversation if the prompt is considered unsafe based on the LLM classification.", "$ref": "GuardrailLlmPromptSecurity" }, "updateTime": { "description": "Output only. Timestamp when the guardrail was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "id": "Guardrail", "description": "Guardrail contains a list of checks and balances to keep the agents safe and secure.", "type": "object" }, "GuardrailLlmPromptSecurityDefaultSecuritySettings": { "id": "GuardrailLlmPromptSecurityDefaultSecuritySettings", "description": "Configuration for default system security settings.", "type": "object", "properties": { "defaultPromptTemplate": { "description": "Output only. The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY.", "readOnly": true, "type": "string" } } }, "LfA2aV1Artifact": { "id": "LfA2aV1Artifact", "description": "Artifacts represent task outputs.", "type": "object", "properties": { "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Metadata included with the artifact.", "type": "object" }, "extensions": { "items": { "type": "string" }, "description": "The URIs of extensions that are present or contributed to this Artifact.", "type": "array" }, "artifactId": { "description": "Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.", "type": "string" }, "parts": { "items": { "$ref": "LfA2aV1Part" }, "description": "Required. The content of the artifact. Must contain at least one part.", "type": "array" }, "name": { "description": "A human readable name for the artifact.", "type": "string" }, "description": { "description": "Optional. A human readable description of the artifact.", "type": "string" } } }, "CitationsCitedChunk": { "id": "CitationsCitedChunk", "description": "Piece of cited information.", "type": "object", "properties": { "text": { "description": "Text used for citation.", "type": "string" }, "title": { "description": "Title of the cited document.", "type": "string" }, "requiresAttribution": { "description": "Whether this citation requires attribution to be shown to the end users.", "type": "boolean" }, "uri": { "description": "URI used for citation.", "type": "string" } } }, "OAuthConfig": { "properties": { "clientId": { "description": "Required. The client ID from the OAuth provider.", "type": "string" }, "oauthGrantType": { "description": "Required. OAuth grant types.", "type": "string", "enum": [ "OAUTH_GRANT_TYPE_UNSPECIFIED", "CLIENT_CREDENTIAL" ], "enumDescriptions": [ "Unspecified. Defaults to CLIENT_CREDENTIAL.", "Represents the [client credential flow](https://oauth.net/2/grant-types/client-credentials)." ] }, "scopes": { "description": "Optional. The OAuth scopes to grant.", "type": "array", "items": { "type": "string" } }, "clientSecretVersion": { "description": "Required. The name of the SecretManager secret version resource storing the client secret. 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`.", "type": "string" }, "tokenEndpoint": { "description": "Required. The token endpoint in the OAuth provider to exchange for an access token.", "type": "string" } }, "id": "OAuthConfig", "description": "Configurations for authentication with OAuth.", "type": "object" }, "AppVariableDeclaration": { "id": "AppVariableDeclaration", "description": "Defines the structure and metadata for a variable.", "type": "object", "properties": { "schema": { "description": "Required. The schema of the variable.", "$ref": "Schema" }, "name": { "description": "Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores.", "type": "string" }, "description": { "description": "Required. The description of the variable.", "type": "string" } } }, "Event": { "id": "Event", "description": "Event input.", "type": "object", "properties": { "event": { "description": "Required. The name of the event.", "type": "string" } } }, "GuardrailContentFilter": { "properties": { "bannedContentsInUserInput": { "items": { "type": "string" }, "description": "Optional. List of banned phrases. Applies only to user inputs.", "type": "array" }, "bannedContents": { "items": { "type": "string" }, "description": "Optional. List of banned phrases. Applies to both user inputs and agent responses.", "type": "array" }, "bannedContentsInAgentResponse": { "description": "Optional. List of banned phrases. Applies only to agent responses.", "type": "array", "items": { "type": "string" } }, "matchType": { "enumDescriptions": [ "Match type is not specified.", "Content is matched for substrings character by character.", "Content only matches if the pattern found in the text is surrounded by word delimiters. Banned phrases can also contain word delimiters.", "Content is matched using regular expression syntax." ], "description": "Required. Match type for the content filter.", "type": "string", "enum": [ "MATCH_TYPE_UNSPECIFIED", "SIMPLE_STRING_MATCH", "WORD_BOUNDARY_STRING_MATCH", "REGEXP_MATCH" ] }, "disregardDiacritics": { "description": "Optional. If true, diacritics are ignored during matching.", "type": "boolean" } }, "id": "GuardrailContentFilter", "description": "Guardrail that bans certain content from being used in the conversation.", "type": "object" }, "LfA2aV1OAuthFlows": { "id": "LfA2aV1OAuthFlows", "description": "Defines the configuration for the supported OAuth 2.0 flows.", "type": "object", "properties": { "clientCredentials": { "description": "Configuration for the OAuth Client Credentials flow.", "$ref": "LfA2aV1ClientCredentialsOAuthFlow" }, "implicit": { "deprecated": true, "$ref": "LfA2aV1ImplicitOAuthFlow", "description": "Deprecated: Use Authorization Code + PKCE instead." }, "authorizationCode": { "description": "Configuration for the OAuth Authorization Code flow.", "$ref": "LfA2aV1AuthorizationCodeOAuthFlow" }, "deviceCode": { "description": "Configuration for the OAuth Device Code flow.", "$ref": "LfA2aV1DeviceCodeOAuthFlow" }, "password": { "description": "Deprecated: Use Authorization Code + PKCE or Device Code.", "deprecated": true, "$ref": "LfA2aV1PasswordOAuthFlow" } } }, "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { "id": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", "type": "object", "properties": { "attributeValue": { "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" }, "boostAmount": { "description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", "type": "number", "format": "float" } } }, "ChannelProfile": { "properties": { "noiseSuppressionLevel": { "description": "Optional. The noise suppression level of the channel profile. Available values are \"low\", \"moderate\", \"high\", \"very_high\".", "type": "string" }, "profileId": { "description": "Optional. The unique identifier of the channel profile.", "type": "string" }, "channelType": { "enumDescriptions": [ "Unknown channel type.", "Web UI channel.", "API channel.", "Twilio channel.", "Google Telephony Platform channel.", "Contact Center as a Service (CCaaS) channel.", "Contact Center as a Service (CCaaS Chat) channel.", "Five9 channel.", "Third party contact center integration channel.", "WhatsApp channel.", "Instagram channel." ], "description": "Optional. The type of the channel profile.", "type": "string", "enum": [ "UNKNOWN", "WEB_UI", "API", "TWILIO", "GOOGLE_TELEPHONY_PLATFORM", "CONTACT_CENTER_AS_A_SERVICE", "CONTACT_CENTER_AS_A_SERVICE_CHAT", "FIVE9", "CONTACT_CENTER_INTEGRATION", "WHATSAPP", "INSTAGRAM" ] }, "whatsappConfig": { "description": "Optional. Configuration specific to WhatsApp deployments.", "$ref": "ChannelProfileWhatsAppConfig" }, "personaProperty": { "description": "Optional. The persona property of the channel profile.", "$ref": "ChannelProfilePersonaProperty" }, "disableDtmf": { "description": "Optional. Whether to disable DTMF (dual-tone multi-frequency).", "type": "boolean" }, "disableBargeInControl": { "description": "Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.", "type": "boolean" }, "webWidgetConfig": { "description": "Optional. The configuration for the web widget.", "$ref": "ChannelProfileWebWidgetConfig" }, "instagramConfig": { "description": "Optional. Configuration specific to Instagram deployments.", "$ref": "ChannelProfileInstagramConfig" } }, "id": "ChannelProfile", "description": "A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony.", "type": "object" }, "ToolResponses": { "properties": { "toolResponses": { "items": { "$ref": "ToolResponse" }, "description": "Optional. The list of tool execution results.", "type": "array" } }, "id": "ToolResponses", "description": "Execution results for the requested tool calls from the client.", "type": "object" }, "ExecuteToolRequest": { "id": "ExecuteToolRequest", "description": "Request message for ToolService.ExecuteTool.", "type": "object", "properties": { "tool": { "description": "Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}", "type": "string" }, "toolsetTool": { "description": "Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.", "$ref": "ToolsetTool" }, "args": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The input parameters and values for the tool in JSON object format.", "type": "object" }, "context": { "description": "Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "mockConfig": { "description": "Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.", "$ref": "MockConfig" }, "variables": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The variables that are available for the tool execution.", "type": "object" } } }, "ListDeploymentsResponse": { "id": "ListDeploymentsResponse", "description": "Response message for AgentService.ListDeployments.", "type": "object", "properties": { "deployments": { "items": { "$ref": "Deployment" }, "description": "The list of deployments.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "AmbientSoundConfig": { "properties": { "volumeGainDb": { "description": "Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.", "type": "number", "format": "double" }, "prebuiltAmbientNoise": { "deprecated": true, "description": "Optional. Deprecated: `prebuilt_ambient_noise` is deprecated in favor of `prebuilt_ambient_sound`.", "type": "string", "enumDescriptions": [ "Not specified.", "Ambient noise of a retail store.", "Ambient noise of a convention hall.", "Ambient noise of a street." ], "enum": [ "PREBUILT_AMBIENT_NOISE_UNSPECIFIED", "RETAIL_STORE", "CONVENTION_HALL", "OUTDOOR" ] }, "gcsUri": { "description": "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.", "type": "string" }, "prebuiltAmbientSound": { "description": "Optional. Name of the prebuilt ambient sound. Valid values are: - \"coffee_shop\" - \"keyboard\" - \"keypad\" - \"hum\" - \"office_1\" - \"office_2\" - \"office_3\" - \"room_1\" - \"room_2\" - \"room_3\" - \"room_4\" - \"room_5\" - \"air_conditioner\"", "type": "string" } }, "id": "AmbientSoundConfig", "description": "Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.", "type": "object" }, "OpenApiToolset": { "id": "OpenApiToolset", "description": "A toolset that contains a list of tools that are defined by an OpenAPI schema.", "type": "object", "properties": { "openApiSchema": { "description": "Required. The OpenAPI schema of the toolset.", "type": "string" }, "apiAuthentication": { "description": "Optional. Authentication information required by the API.", "$ref": "ApiAuthentication" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates", "$ref": "TlsConfig" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration.", "$ref": "ServiceDirectoryConfig" }, "ignoreUnknownFields": { "description": "Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.", "type": "boolean" }, "url": { "description": "Optional. The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.", "type": "string" } } }, "BearerTokenConfig": { "id": "BearerTokenConfig", "description": "Configurations for authentication with a bearer token.", "type": "object", "properties": { "token": { "description": "Required. The bearer token. Must be in the format `$context.variables.`.", "type": "string" } } }, "GuardrailModelSafety": { "properties": { "safetySettings": { "items": { "$ref": "GuardrailModelSafetySafetySetting" }, "description": "Required. List of safety settings.", "type": "array" } }, "id": "GuardrailModelSafety", "description": "Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe.", "type": "object" }, "Conversation": { "properties": { "appVersion": { "description": "Output only. The version of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "readOnly": true, "type": "string" }, "languageCode": { "description": "Output only. The language code of the conversation.", "readOnly": true, "type": "string" }, "name": { "description": "Identifier. The unique identifier of the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`", "type": "string" }, "entryAgent": { "description": "Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "readOnly": true, "type": "string" }, "deployment": { "description": "Output only. The deployment of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "readOnly": true, "type": "string" }, "startTime": { "description": "Output only. Timestamp when the conversation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "channelType": { "deprecated": true, "description": "DEPRECATED. Please use input_types instead.", "type": "string", "enumDescriptions": [ "Unspecified channel type.", "The conversation only contains text messages between the end user and the agent.", "The conversation contains audio messages between the end user and the agent.", "The conversation multi-modal messages (e.g. image) between the end user and the agent." ], "enum": [ "CHANNEL_TYPE_UNSPECIFIED", "TEXT", "AUDIO", "MULTIMODAL" ] }, "turnCount": { "description": "Output only. The number of turns in the conversation.", "readOnly": true, "type": "integer", "format": "int32" }, "source": { "description": "Output only. Indicate the source of the conversation.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ] }, "turns": { "description": "Required. The turns in the conversation.", "type": "array", "items": { "$ref": "ConversationTurn" } }, "messages": { "description": "Deprecated. Use turns instead.", "type": "array", "items": { "$ref": "Message" }, "deprecated": true }, "endTime": { "description": "Output only. Timestamp when the conversation was completed.", "readOnly": true, "type": "string", "format": "google-datetime" }, "inputTypes": { "description": "Output only. The input types of the conversation.", "readOnly": true, "type": "array", "items": { "type": "string", "enum": [ "INPUT_TYPE_UNSPECIFIED", "INPUT_TYPE_TEXT", "INPUT_TYPE_EVENT", "INPUT_TYPE_AUDIO", "INPUT_TYPE_IMAGE", "INPUT_TYPE_BLOB", "INPUT_TYPE_TOOL_RESPONSE", "INPUT_TYPE_VARIABLES" ], "enumDescriptions": [ "Unspecified input type.", "Text input.", "Event input.", "Audio input.", "Image input.", "Blob input.", "Client function tool response input.", "Variables input." ] } } }, "id": "Conversation", "description": "A conversation represents an interaction between an end user and the CES app.", "type": "object" }, "SessionInput": { "id": "SessionInput", "description": "Input for the session.", "type": "object", "properties": { "event": { "description": "Optional. Event input.", "$ref": "Event" }, "text": { "description": "Optional. Text data from the end user.", "type": "string" }, "audio": { "description": "Optional. Audio data from the end user.", "type": "string", "format": "byte" }, "willContinue": { "description": "Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.", "type": "boolean" }, "toolResponses": { "description": "Optional. Execution results for the tool calls from the client.", "$ref": "ToolResponses" }, "image": { "description": "Optional. Image data from the end user.", "$ref": "Image" }, "blob": { "description": "Optional. Blob data from the end user.", "$ref": "Blob" }, "variables": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.", "type": "object" }, "dtmf": { "description": "Optional. DTMF digits from the end user.", "type": "string" } } }, "ErrorHandlingSettingsEndSessionConfig": { "id": "ErrorHandlingSettingsEndSessionConfig", "description": "Configuration for ending the session in case of system errors (e.g. LLM errors).", "type": "object", "properties": { "escalateSession": { "description": "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.", "type": "boolean" } } }, "ToolsetTool": { "id": "ToolsetTool", "description": "A tool that is created from a toolset.", "type": "object", "properties": { "toolId": { "description": "Optional. The tool ID to filter the tools to retrieve the schema for.", "type": "string" }, "toolset": { "description": "Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string" } } }, "DataStoreToolEngineSource": { "properties": { "engine": { "description": "Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string" }, "filter": { "description": "Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata", "type": "string" }, "dataStoreSources": { "items": { "$ref": "DataStoreToolDataStoreSource" }, "description": "Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.", "type": "array" } }, "id": "DataStoreToolEngineSource", "description": "Configuration for searching within an Engine, potentially targeting specific DataStores.", "type": "object" }, "ListToolsResponse": { "id": "ListToolsResponse", "description": "Response message for AgentService.ListTools.", "type": "object", "properties": { "tools": { "items": { "$ref": "Tool" }, "description": "The list of tools.", "type": "array" }, "nextPageToken": { "description": "A token that can be sent as ListToolsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } } }, "DataStoreTool": { "properties": { "dataStoreSource": { "description": "Optional. Search within a single specific DataStore.", "$ref": "DataStoreToolDataStoreSource" }, "name": { "description": "Required. The data store tool name.", "type": "string" }, "description": { "description": "Optional. The tool description.", "type": "string" }, "engineSource": { "description": "Optional. Search within an Engine (potentially across multiple DataStores).", "$ref": "DataStoreToolEngineSource" }, "boostSpecs": { "items": { "$ref": "DataStoreToolBoostSpecs" }, "description": "Optional. Boost specification to boost certain documents.", "type": "array" }, "modalityConfigs": { "description": "Optional. The modality configs for the data store.", "type": "array", "items": { "$ref": "DataStoreToolModalityConfig" } }, "filterParameterBehavior": { "enumDescriptions": [ "Default filter behavior. Include filter parameter for connector datastores. For the rest of the datastore types, the filter input parameter is omitted.", "Always include filter parameter for all datastore types.", "The filter parameter is never included in the list of tool parameters, regardless of the datastore type." ], "description": "Optional. The filter parameter behavior.", "type": "string", "enum": [ "FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED", "ALWAYS_INCLUDE", "NEVER_INCLUDE" ] } }, "id": "DataStoreTool", "description": "Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.", "type": "object" }, "ApiAuthentication": { "id": "ApiAuthentication", "description": "Authentication information required for API calls.", "type": "object", "properties": { "oauthConfig": { "description": "Optional. Config for OAuth.", "$ref": "OAuthConfig" }, "serviceAccountAuthConfig": { "description": "Optional. Config for service account authentication.", "$ref": "ServiceAccountAuthConfig" }, "serviceAgentIdTokenAuthConfig": { "description": "Optional. Config for ID token auth generated from CES service agent.", "$ref": "ServiceAgentIdTokenAuthConfig" }, "apiKeyConfig": { "description": "Optional. Config for API key auth.", "$ref": "ApiKeyConfig" }, "bearerTokenConfig": { "description": "Optional. Config for bearer token auth.", "$ref": "BearerTokenConfig" } } }, "SessionOutput": { "id": "SessionOutput", "description": "Output for the session.", "type": "object", "properties": { "googleSearchSuggestions": { "description": "The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.", "$ref": "GoogleSearchSuggestions" }, "diagnosticInfo": { "description": "Optional. Diagnostic information contains execution details during the processing of the input. Only populated in the last SessionOutput (with `turn_completed=true`) for each turn.", "$ref": "SessionOutputDiagnosticInfo" }, "payload": { "description": "Custom payload with structured output from the CES agent.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "turnIndex": { "description": "Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.", "type": "integer", "format": "int32" }, "toolCalls": { "description": "Request for the client to execute the tools.", "$ref": "ToolCalls" }, "turnCompleted": { "description": "If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn.", "type": "boolean" }, "context": { "description": "Context messages for external supervision guardrails.", "type": "array", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } }, "text": { "description": "Output text from the CES agent.", "type": "string" }, "citations": { "description": "Citations that provide the source information for the agent's generated text.", "$ref": "Citations" }, "audio": { "description": "Output audio from the CES agent.", "type": "string", "format": "byte" }, "endSession": { "description": "Indicates the session has ended.", "$ref": "EndSession" } } }, "LfA2aV1AgentExtension": { "id": "LfA2aV1AgentExtension", "description": "A declaration of a protocol extension supported by an Agent.", "type": "object", "properties": { "uri": { "description": "The unique URI identifying the extension.", "type": "string" }, "description": { "description": "A human-readable description of how this agent uses the extension.", "type": "string" }, "required": { "description": "If true, the client must understand and comply with the extension's requirements.", "type": "boolean" }, "params": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Extension-specific configuration parameters.", "type": "object" } } }, "App": { "properties": { "modelSettings": { "description": "Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.", "$ref": "ModelSettings" }, "rootAgent": { "description": "Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "audioProcessingConfig": { "description": "Optional. Audio processing configuration of the app.", "$ref": "AudioProcessingConfig" }, "evaluationMetricsThresholds": { "description": "Optional. The evaluation thresholds for the app.", "$ref": "EvaluationMetricsThresholds" }, "clientCertificateSettings": { "description": "Optional. The default client certificate settings for the app.", "$ref": "ClientCertificateSettings" }, "locked": { "description": "Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.", "type": "boolean" }, "pinned": { "description": "Optional. Whether the app is pinned in the app list.", "type": "boolean" }, "deploymentCount": { "description": "Output only. Number of deployments in the app.", "readOnly": true, "type": "integer", "format": "int32" }, "createTime": { "description": "Output only. Timestamp when the app was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "errorHandlingSettings": { "description": "Optional. Error handling settings of the app.", "$ref": "ErrorHandlingSettings" }, "predefinedVariableDeclarations": { "description": "Output only. The declarations of predefined variables for the app.", "readOnly": true, "type": "array", "items": { "$ref": "AppVariableDeclaration" } }, "globalInstruction": { "description": "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.", "type": "string" }, "variableDeclarations": { "description": "Optional. The declarations of the variables.", "type": "array", "items": { "$ref": "AppVariableDeclaration" } }, "updateTime": { "description": "Output only. Timestamp when the app was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "loggingSettings": { "description": "Optional. Logging settings of the app.", "$ref": "LoggingSettings" }, "toolExecutionMode": { "enumDescriptions": [ "Unspecified tool execution mode. Default to PARALLEL.", "If there are multiple tools being selected, they will be executed in parallel, with the same [ToolContext](https://google.github.io/adk-docs/context/#the-different-types-of-context).", "If there are multiple tools being selected, they will be executed sequentially. The next tool will only be executed after the previous tool completes and it can see updated [ToolContext](https://google.github.io/adk-docs/context/#the-different-types-of-context) from the previous tool." ], "description": "Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.", "type": "string", "enum": [ "TOOL_EXECUTION_MODE_UNSPECIFIED", "PARALLEL", "SEQUENTIAL" ] }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.", "type": "object" }, "dataStoreSettings": { "description": "Optional. The data store settings for the app.", "$ref": "DataStoreSettings" }, "timeZoneSettings": { "description": "Optional. TimeZone settings of the app.", "$ref": "TimeZoneSettings" }, "etag": { "description": "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.", "readOnly": true, "type": "string" }, "vpcScSettings": { "description": "Optional. VPC-SC settings for the app.", "$ref": "VpcScSettings" }, "name": { "description": "Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string" }, "languageSettings": { "description": "Optional. Language settings of the app.", "$ref": "LanguageSettings" }, "defaultChannelProfile": { "description": "Optional. The default channel profile used by the app.", "$ref": "ChannelProfile" }, "description": { "description": "Optional. Human-readable description of the app.", "type": "string" }, "displayName": { "description": "Required. Display name of the app.", "type": "string" }, "validationErrors": { "items": { "type": "string" }, "description": "Output only. Misconfigurations or warnings in the app.", "readOnly": true, "type": "array" }, "guardrails": { "description": "Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "type": "array", "items": { "type": "string" } } }, "id": "App", "description": "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.", "type": "object" }, "Deployment": { "id": "Deployment", "description": "A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.", "type": "object", "properties": { "name": { "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" }, "createTime": { "description": "Output only. Timestamp when this deployment was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "appVersion": { "description": "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.", "type": "string" }, "etag": { "description": "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.", "readOnly": true, "type": "string" }, "modelSettings": { "description": "Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field.", "$ref": "ModelSettings" }, "displayName": { "description": "Required. Display name of the deployment.", "type": "string" }, "modality": { "enumDescriptions": [ "Unknown modality.", "Text modality.", "Voice modality.", "Video modality." ], "description": "Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field.", "type": "string", "enum": [ "MODALITY_UNSPECIFIED", "MODALITY_TEXT", "MODALITY_VOICE", "MODALITY_VIDEO" ] }, "channelProfile": { "description": "Required. The channel profile used in the deployment.", "$ref": "ChannelProfile" }, "experimentConfig": { "description": "Optional. Experiment configuration for the deployment.", "$ref": "ExperimentConfig" }, "instagramCredentials": { "description": "Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile.", "$ref": "InstagramCredentials" }, "updateTime": { "description": "Output only. Timestamp when this deployment was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "whatsappCredentials": { "description": "Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile.", "$ref": "WhatsAppCredentials" } } }, "InstagramCredentials": { "id": "InstagramCredentials", "description": "Ephemeral Meta credentials for Instagram native integration.", "type": "object", "properties": { "authCode": { "description": "Required. The Meta auth code provided by the embedded signup flow.", "type": "string" }, "conversationProfileId": { "description": "Optional. The Conversation Profile ID to use for the deployment.", "type": "string" } } }, "ListAppVersionsResponse": { "properties": { "appVersions": { "description": "The list of app versions.", "type": "array", "items": { "$ref": "AppVersion" } }, "nextPageToken": { "description": "A token that can be sent as ListAppVersionsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } }, "id": "ListAppVersionsResponse", "description": "Response message for AgentService.ListAppVersions.", "type": "object" }, "Span": { "id": "Span", "description": "A span is a unit of work or a single operation during the request processing.", "type": "object", "properties": { "endTime": { "description": "Output only. The end time of the span.", "readOnly": true, "type": "string", "format": "google-datetime" }, "attributes": { "description": "Output only. Key-value attributes associated with the span.", "readOnly": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "childSpans": { "items": { "$ref": "Span" }, "description": "Output only. The child spans that are nested under this span.", "readOnly": true, "type": "array" }, "duration": { "description": "Output only. The duration of the span.", "readOnly": true, "type": "string", "format": "google-duration" }, "name": { "description": "Output only. The name of the span.", "readOnly": true, "type": "string" }, "startTime": { "description": "Output only. The start time of the span.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "ChannelProfileWebWidgetConfigSecuritySettings": { "properties": { "allowedOrigins": { "description": "Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: \"https://example.com\"", "type": "array", "items": { "type": "string" } }, "enableOriginCheck": { "description": "Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.", "type": "boolean" }, "enablePublicAccess": { "description": "Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.", "type": "boolean" }, "enableRecaptcha": { "description": "Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.", "type": "boolean" } }, "id": "ChannelProfileWebWidgetConfigSecuritySettings", "description": "Security settings for the web widget.", "type": "object" }, "GuardrailLlmPromptSecurity": { "id": "GuardrailLlmPromptSecurity", "description": "Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification.", "type": "object", "properties": { "defaultSettings": { "description": "Optional. Use the system's predefined default security settings. To select this mode, include an empty 'default_settings' message in the request. The 'default_prompt_template' field within will be populated by the server in the response.", "$ref": "GuardrailLlmPromptSecurityDefaultSecuritySettings" }, "failOpen": { "description": "Optional. Determines the behavior when the guardrail encounters an LLM error. - If true: the guardrail is bypassed. - If false (default): the guardrail triggers/blocks. Note: If a custom policy is provided, this field is ignored in favor of the policy's 'fail_open' configuration.", "type": "boolean" }, "customPolicy": { "description": "Optional. Use a user-defined LlmPolicy to configure the security guardrail.", "$ref": "GuardrailLlmPolicy" } } }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds": { "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds", "description": "Settings for golden evaluations.", "type": "object", "properties": { "expectationLevelMetricsThresholds": { "description": "Optional. The expectation level metrics thresholds.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds" }, "toolMatchingSettings": { "description": "Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.", "$ref": "EvaluationMetricsThresholdsToolMatchingSettings" }, "turnLevelMetricsThresholds": { "description": "Optional. The turn level metrics thresholds.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds" } } }, "ListGuardrailsResponse": { "id": "ListGuardrailsResponse", "description": "Response message for AgentService.ListGuardrails.", "type": "object", "properties": { "guardrails": { "description": "The list of guardrails.", "type": "array", "items": { "$ref": "Guardrail" } }, "nextPageToken": { "description": "A token that can be sent as ListGuardrailsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } } }, "LfA2aV1ImplicitOAuthFlow": { "id": "LfA2aV1ImplicitOAuthFlow", "description": "Deprecated: Use Authorization Code + PKCE instead.", "type": "object", "properties": { "authorizationUrl": { "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS", "type": "string" }, "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" }, "scopes": { "additionalProperties": { "type": "string" }, "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.", "type": "object" } } }, "DataStoreToolBoostSpec": { "properties": { "conditionBoostSpecs": { "description": "Required. A list of boosting specifications.", "type": "array", "items": { "$ref": "DataStoreToolBoostSpecConditionBoostSpec" } } }, "id": "DataStoreToolBoostSpec", "description": "Boost specification to boost certain documents.", "type": "object" }, "ListChangelogsResponse": { "properties": { "changelogs": { "description": "The list of changelogs.", "type": "array", "items": { "$ref": "Changelog" } }, "nextPageToken": { "description": "A token that can be sent as ListChangelogsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } }, "id": "ListChangelogsResponse", "description": "Response message for AgentService.ListChangelogs.", "type": "object" }, "LfA2aV1Message": { "id": "LfA2aV1Message", "description": "`Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it.", "type": "object", "properties": { "taskId": { "description": "Optional. The task id of the message. If set, the message will be associated with the given task.", "type": "string" }, "messageId": { "description": "Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.", "type": "string" }, "metadata": { "description": "Optional. Any metadata to provide along with the message.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "extensions": { "description": "The URIs of extensions that are present or contributed to this Message.", "type": "array", "items": { "type": "string" } }, "contextId": { "description": "Optional. The context id of the message. If set, the message will be associated with the given context.", "type": "string" }, "role": { "enumDescriptions": [ "The role is unspecified.", "The message is from the client to the server.", "The message is from the server to the client." ], "description": "Required. Identifies the sender of the message.", "type": "string", "enum": [ "ROLE_UNSPECIFIED", "ROLE_USER", "ROLE_AGENT" ] }, "referenceTaskIds": { "items": { "type": "string" }, "description": "A list of task IDs that this message references for additional context.", "type": "array" }, "parts": { "description": "Required. Parts is the container of the message content.", "type": "array", "items": { "$ref": "LfA2aV1Part" } } } }, "ToolCall": { "properties": { "id": { "description": "Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.", "type": "string" }, "args": { "description": "Optional. The input parameters and values for the tool in JSON object format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "toolsetTool": { "description": "Optional. The toolset tool to execute.", "$ref": "ToolsetTool" }, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "displayName": { "description": "Output only. Display name of the tool.", "readOnly": true, "type": "string" } }, "id": "ToolCall", "description": "Request for the client or the agent to execute the specified tool.", "type": "object" }, "EndUserAuthConfigOauth2AuthCodeConfig": { "properties": { "oauthToken": { "description": "Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" } }, "id": "EndUserAuthConfigOauth2AuthCodeConfig", "description": "Oauth 2.0 Authorization Code authentication configuration.", "type": "object" }, "LfA2aV1SendMessageConfiguration": { "properties": { "acceptedOutputModes": { "description": "A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output.", "type": "array", "items": { "type": "string" } }, "historyLength": { "description": "The maximum number of most recent messages from the task's history to retrieve in the response. An unset value means the client does not impose any limit. A value of zero is a request to not include any messages. The server MUST NOT return more messages than the provided value, but MAY apply a lower limit.", "type": "integer", "format": "int32" }, "taskPushNotificationConfig": { "description": "Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request.", "$ref": "LfA2aV1TaskPushNotificationConfig" }, "returnImmediately": { "description": "If `true`, the operation returns immediately after creating the task, even if processing is still in progress. If `false` (default), the operation MUST wait until the task reaches a terminal (`COMPLETED`, `FAILED`, `CANCELED`, `REJECTED`) or interrupted (`INPUT_REQUIRED`, `AUTH_REQUIRED`) state before returning.", "type": "boolean" } }, "id": "LfA2aV1SendMessageConfiguration", "description": "Configuration of a send message request.", "type": "object" }, "MockedToolCall": { "id": "MockedToolCall", "description": "A mocked tool call. Expresses the target tool + a pattern to match against that tool's args / inputs. If the pattern matches, then the mock response will be returned.", "type": "object", "properties": { "toolId": { "description": "Optional. The name of the tool to mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "tool": { "description": "Optional. Deprecated. Use tool_identifier instead.", "type": "string", "deprecated": true }, "toolset": { "description": "Optional. The toolset to mock.", "$ref": "ToolsetTool" }, "expectedArgsPattern": { "description": "Required. A pattern to match against the args / inputs of all dispatched tool calls. If the tool call inputs match this pattern, then mock output will be returned.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "mockResponse": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The mock response / output to return if the tool call args / inputs match the pattern.", "type": "object" } } }, "TriggerActionGenerativeAnswer": { "properties": { "prompt": { "description": "Required. The prompt to use for the generative answer.", "type": "string" } }, "id": "TriggerActionGenerativeAnswer", "description": "The agent will immediately respond with a generative answer.", "type": "object" }, "ListOperationsResponse": { "properties": { "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object" }, "ListToolsetsResponse": { "properties": { "nextPageToken": { "description": "A token that can be sent as ListToolsetsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" }, "toolsets": { "description": "The list of toolsets.", "type": "array", "items": { "$ref": "Toolset" } } }, "id": "ListToolsetsResponse", "description": "Response message for AgentService.ListToolsets.", "type": "object" }, "ConnectorToolset": { "properties": { "connectorActions": { "description": "Required. The list of connector actions/entity operations to generate tools for.", "type": "array", "items": { "$ref": "Action" } }, "connection": { "description": "Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`", "type": "string" }, "authConfig": { "description": "Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the Toolset creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override", "$ref": "EndUserAuthConfig" } }, "id": "ConnectorToolset", "description": "A toolset that generates tools from an Integration Connectors Connection.", "type": "object" }, "LfA2aV1AuthorizationCodeOAuthFlow": { "id": "LfA2aV1AuthorizationCodeOAuthFlow", "description": "Defines configuration details for the OAuth 2.0 Authorization Code flow.", "type": "object", "properties": { "tokenUrl": { "description": "Required. The token URL to be used for this flow.", "type": "string" }, "pkceRequired": { "description": "Indicates if PKCE (RFC 7636) is required for this flow. PKCE should always be used for public clients and is recommended for all clients.", "type": "boolean" }, "authorizationUrl": { "description": "Required. The authorization URL to be used for this flow.", "type": "string" }, "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Required. The available scopes for the OAuth2 security scheme.", "type": "object" } } }, "BargeInConfig": { "properties": { "disableBargeIn": { "description": "Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.", "type": "boolean", "deprecated": true }, "bargeInAwareness": { "description": "Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.", "type": "boolean" } }, "id": "BargeInConfig", "description": "Configuration for how the user barge-in activities should be handled.", "type": "object" }, "ExperimentConfigVersionReleaseTrafficAllocation": { "properties": { "id": { "description": "Optional. Id of the traffic allocation. Free format string, up to 128 characters.", "type": "string" }, "trafficPercentage": { "description": "Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100.", "type": "integer", "format": "int32" }, "appVersion": { "description": "Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" } }, "id": "ExperimentConfigVersionReleaseTrafficAllocation", "description": "Traffic allocation for the version release.", "type": "object" }, "ServiceAgentIdTokenAuthConfig": { "properties": {}, "id": "ServiceAgentIdTokenAuthConfig", "description": "Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent.", "type": "object" }, "OutputAudioConfig": { "id": "OutputAudioConfig", "description": "OutputAudioConfig configures how the CES agent should synthesize outgoing audio responses.", "type": "object", "properties": { "audioEncoding": { "enumDescriptions": [ "Unspecified audio encoding.", "16-bit linear PCM audio encoding.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law." ], "description": "Required. The encoding of the output audio data.", "type": "string", "enum": [ "AUDIO_ENCODING_UNSPECIFIED", "LINEAR16", "MULAW", "ALAW" ] }, "sampleRateHertz": { "description": "Required. The sample rate (in Hertz) of the output audio data.", "type": "integer", "format": "int32" } } }, "SynthesizeSpeechConfig": { "properties": { "voiceSampleGcsUri": { "description": "Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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.", "type": "string", "deprecated": true }, "instruction": { "description": "Optional. The instruction used to synthesize speech when using a generative model.", "type": "string" }, "speakingRate": { "description": "Optional. The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.", "type": "number", "format": "double" }, "consentAudioGcsUri": { "deprecated": true, "description": "Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the consent audio for voice cloning.", "type": "string" }, "voice": { "description": "Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud Text-to-Speech.", "type": "string" }, "model": { "description": "Optional. The model used to synthesize audio. Currently supported values: - \"gemini-3.1-flash-tts-preview\" If empty, Chirp3-HD is used.", "type": "string" } }, "id": "SynthesizeSpeechConfig", "description": "Configuration for how the agent response should be synthesized.", "type": "object" }, "PythonCodeCondition": { "properties": { "pythonCode": { "description": "Required. The python code to execute.", "type": "string" } }, "id": "PythonCodeCondition", "description": "Python code block to evaluate the condition.", "type": "object" }, "LfA2aV1APIKeySecurityScheme": { "id": "LfA2aV1APIKeySecurityScheme", "description": "Defines a security scheme using an API key.", "type": "object", "properties": { "description": { "description": "An optional description for the security scheme.", "type": "string" }, "name": { "description": "Required. The name of the header, query, or cookie parameter to be used.", "type": "string" }, "location": { "description": "Required. The location of the API key. Valid values are \"query\", \"header\", or \"cookie\".", "type": "string" } } }, "TimeZoneSettings": { "properties": { "timeZone": { "description": "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.", "type": "string" } }, "id": "TimeZoneSettings", "description": "TimeZone settings of the app.", "type": "object" }, "ConversationTurn": { "properties": { "resolvedDeveloperInstruction": { "description": "Output only. The full dynamically resolved developer instruction generated from templates. This field is only populated on-demand when requested during history retrieval. It is not persisted.", "readOnly": true, "type": "string" }, "rootSpan": { "description": "Optional. The root span of the action processing.", "$ref": "Span" }, "userIntendedText": { "description": "Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled.", "type": "string" }, "messages": { "items": { "$ref": "Message" }, "description": "Optional. List of messages in the conversation turn, including user input, agent responses and intermediate events during the processing.", "type": "array" }, "templateAttributes": { "description": "Optional. Variables or configurations referenced by the template engine during dynamic prompt generation. This allows reconstructing the exact prompt sent to the model for this turn.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "id": "ConversationTurn", "description": "All information about a single turn in the conversation.", "type": "object" }, "WidgetToolTextResponseConfig": { "properties": { "type": { "enumDescriptions": [ "Unspecified type.", "The LLM dynamically decides whether to generate a text response alongside the widget based on the conversation context.", "The LLM is explicitly required to generate a text response.", "A pre-defined static text response is always used." ], "description": "Optional. The strategy for providing the text response.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "NONE", "LLM_GENERATED", "STATIC" ] }, "textResponseInstruction": { "description": "Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.", "type": "string" }, "staticText": { "description": "Optional. The static text response to return when type is STATIC.", "type": "string" } }, "id": "WidgetToolTextResponseConfig", "description": "Configuration for the text response returned with the widget.", "type": "object" }, "TriggerActionRespondImmediately": { "id": "TriggerActionRespondImmediately", "description": "The agent will immediately respond with a preconfigured response.", "type": "object", "properties": { "responses": { "description": "Required. The canned responses for the agent to choose from. The response is chosen randomly.", "type": "array", "items": { "$ref": "TriggerActionResponse" } } } }, "DataStore": { "id": "DataStore", "description": "A DataStore resource in Vertex AI Search.", "type": "object", "properties": { "connectorConfig": { "description": "Output only. The connector config for the data store connection.", "readOnly": true, "$ref": "DataStoreConnectorConfig" }, "displayName": { "description": "Output only. The display name of the data store.", "readOnly": true, "type": "string" }, "name": { "description": "Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", "type": "string" }, "type": { "description": "Output only. The type of the data store. This field is readonly and populated by the server.", "readOnly": true, "type": "string", "enumDescriptions": [ "Not specified. This value indicates that the data store type is not specified, so it will not be used during search.", "A data store that contains public web content.", "A data store that contains unstructured private data.", "A data store that contains structured data used as FAQ.", "A data store that is a connector to a first-party or a third-party service." ], "enum": [ "DATA_STORE_TYPE_UNSPECIFIED", "PUBLIC_WEB", "UNSTRUCTURED", "FAQ", "CONNECTOR" ] }, "documentProcessingMode": { "description": "Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.", "readOnly": true, "type": "string", "enum": [ "DOCUMENT_PROCESSING_MODE_UNSPECIFIED", "DOCUMENTS", "CHUNKS" ], "enumDescriptions": [ "Not specified.", "Documents are processed as documents.", "Documents are converted to chunks." ] }, "createTime": { "description": "Output only. Timestamp when the data store was created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "ApiKeyConfig": { "properties": { "keyName": { "description": "Required. The parameter name or the header name of the API key. E.g., If the API request is \"https://example.com/act?X-Api-Key=\", \"X-Api-Key\" would be the parameter name.", "type": "string" }, "requestLocation": { "enumDescriptions": [ "Unspecified. This value should not be used.", "Represents the key in http header.", "Represents the key in query string." ], "description": "Required. Key location in the request.", "type": "string", "enum": [ "REQUEST_LOCATION_UNSPECIFIED", "HEADER", "QUERY_STRING" ] }, "apiKeySecretVersion": { "description": "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`.", "type": "string" } }, "id": "ApiKeyConfig", "description": "Configurations for authentication with API key.", "type": "object" }, "GenerateChatTokenResponse": { "id": "GenerateChatTokenResponse", "description": "Response message for WidgetService.GenerateChatToken.", "type": "object", "properties": { "expireTime": { "description": "The time at which the chat token expires.", "type": "string", "format": "google-datetime" }, "chatToken": { "description": "The session scoped token for chat widget to authenticate with Session APIs.", "type": "string" } } }, "Tool": { "properties": { "generatedSummary": { "description": "Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.", "readOnly": true, "type": "string" }, "toolFakeConfig": { "description": "Optional. Configuration for tool behavior in fake mode.", "$ref": "ToolFakeConfig" }, "fileSearchTool": { "description": "Optional. The file search tool.", "$ref": "FileSearchTool" }, "openApiTool": { "description": "Optional. The open API tool.", "$ref": "OpenApiTool" }, "displayName": { "description": "Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its `name` property.", "readOnly": true, "type": "string" }, "pythonFunction": { "description": "Optional. The python function tool.", "$ref": "PythonFunction" }, "createTime": { "description": "Output only. Timestamp when the tool was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "agentTool": { "description": "Optional. The agent tool.", "$ref": "AgentTool" }, "mcpTool": { "description": "Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.", "$ref": "McpTool" }, "executionType": { "enumDescriptions": [ "The execution type is unspecified. Defaults to `SYNCHRONOUS` if unspecified.", "The tool is executed synchronously. The session is blocked until the tool returns.", "The tool is executed asynchronously. The session will continue while the tool is executing." ], "description": "Optional. The execution type of the tool.", "type": "string", "enum": [ "EXECUTION_TYPE_UNSPECIFIED", "SYNCHRONOUS", "ASYNCHRONOUS" ] }, "connectorTool": { "description": "Optional. The Integration Connector tool.", "$ref": "ConnectorTool" }, "dataStoreTool": { "description": "Optional. The data store tool.", "$ref": "DataStoreTool" }, "updateTime": { "description": "Output only. Timestamp when the tool was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "systemTool": { "description": "Optional. The system tool.", "$ref": "SystemTool" }, "clientFunction": { "description": "Optional. The client function.", "$ref": "ClientFunction" }, "etag": { "description": "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.", "type": "string" }, "remoteAgentTool": { "description": "Optional. The remote agent tool.", "$ref": "RemoteAgentTool" }, "googleSearchTool": { "description": "Optional. The google search tool.", "$ref": "GoogleSearchTool" }, "name": { "description": "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.", "type": "string" }, "timeout": { "description": "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.", "type": "string", "format": "google-duration" }, "widgetTool": { "description": "Optional. The widget tool.", "$ref": "WidgetTool" } }, "id": "Tool", "description": "A tool represents an action that the CES agent can take to achieve certain goals.", "type": "object" }, "Message": { "properties": { "eventTime": { "description": "Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.", "type": "string", "format": "google-datetime" }, "role": { "description": "Optional. The role within the conversation, e.g., user, agent.", "type": "string" }, "chunks": { "items": { "$ref": "Chunk" }, "description": "Optional. Content of the message as a series of chunks.", "type": "array" } }, "id": "Message", "description": "A message within a conversation.", "type": "object" }, "DataStoreToolGroundingConfig": { "id": "DataStoreToolGroundingConfig", "description": "Grounding configuration.", "type": "object", "properties": { "disabled": { "description": "Optional. Whether grounding is disabled.", "type": "boolean" }, "groundingLevel": { "description": "Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.", "type": "number", "format": "float" } } }, "DataStoreToolBoostSpecs": { "id": "DataStoreToolBoostSpecs", "description": "Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.", "type": "object", "properties": { "dataStores": { "description": "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}.", "type": "array", "items": { "type": "string" } }, "spec": { "items": { "$ref": "DataStoreToolBoostSpec" }, "description": "Required. A list of boosting specifications.", "type": "array" } } }, "EndUserAuthConfigOauth2JwtBearerConfig": { "id": "EndUserAuthConfigOauth2JwtBearerConfig", "description": "JWT Profile Oauth 2.0 Authorization Grant authentication configuration.", "type": "object", "properties": { "subject": { "description": "Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" }, "issuer": { "description": "Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" }, "clientKey": { "description": "Required. Client parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" } } }, "TlsConfigCaCert": { "id": "TlsConfigCaCert", "description": "The CA certificate.", "type": "object", "properties": { "displayName": { "description": "Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.", "type": "string" }, "cert": { "description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile \u003c(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```", "type": "string", "format": "byte" } } }, "EvaluationMetricsThresholds": { "id": "EvaluationMetricsThresholds", "description": "Threshold settings for metrics in an Evaluation.", "type": "object", "properties": { "scenarioHallucinationMetricBehavior": { "description": "Optional. The hallucination metric behavior for scenario evaluations.", "type": "string", "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ] }, "hallucinationMetricBehavior": { "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ], "description": "Optional. Deprecated: Use `golden_hallucination_metric_behavior` instead. The hallucination metric behavior is currently used for golden evaluations.", "type": "string", "deprecated": true }, "goldenEvaluationMetricsThresholds": { "description": "Optional. The golden evaluation metrics thresholds.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds" }, "goldenHallucinationMetricBehavior": { "description": "Optional. The hallucination metric behavior for golden evaluations.", "type": "string", "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ] } } }, "RestoreAppVersionRequest": { "id": "RestoreAppVersionRequest", "description": "Request message for AgentService.RestoreAppVersion", "type": "object", "properties": {} }, "Callback": { "properties": { "pythonCode": { "description": "Required. The python code to execute for the callback.", "type": "string" }, "disabled": { "description": "Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.", "type": "boolean" }, "description": { "description": "Optional. Human-readable description of the callback.", "type": "string" }, "proactiveExecutionEnabled": { "description": "Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.", "type": "boolean" } }, "id": "Callback", "description": "A callback defines the custom logic to be executed at various stages of agent interaction.", "type": "object" }, "DataStoreToolBoostSpecConditionBoostSpec": { "properties": { "condition": { "description": "Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY(\"en\", \"fr\"))", "type": "string" }, "boost": { "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.", "type": "number", "format": "float" }, "boostControlSpec": { "description": "Optional. Complex specification for custom ranking based on customer defined attribute value.", "$ref": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec" } }, "id": "DataStoreToolBoostSpecConditionBoostSpec", "description": "Boost specification for a condition.", "type": "object" }, "AgentInterface": { "id": "AgentInterface", "description": "Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.", "type": "object", "properties": { "url": { "description": "Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: \"https://api.example.com/a2a/v1\", \"https://grpc.example.com/a2a\"", "type": "string" }, "tenant": { "description": "Tenant ID to be used in the request when calling the agent.", "type": "string" }, "protocolBinding": { "description": "Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.", "type": "string" }, "protocolVersion": { "description": "Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: \"0.3\", \"1.0\"", "type": "string" } } }, "SystemTool": { "id": "SystemTool", "description": "Pre-defined system tool.", "type": "object", "properties": { "name": { "description": "Required. The name of the system tool.", "type": "string" }, "description": { "description": "Output only. The description of the system tool.", "readOnly": true, "type": "string" } } }, "LfA2aV1AuthenticationInfo": { "properties": { "scheme": { "description": "Required. HTTP Authentication Scheme from the [IANA registry](https://www.iana.org/assignments/http-authschemes/). Examples: `Bearer`, `Basic`, `Digest`. Scheme names are case-insensitive per [RFC 9110 Section 11.1](https://www.rfc-editor.org/rfc/rfc9110#section-11.1).", "type": "string" }, "credentials": { "description": "Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).", "type": "string" } }, "id": "LfA2aV1AuthenticationInfo", "description": "Defines authentication details, used for push notifications.", "type": "object" }, "SessionConfigRemoteDialogflowQueryParameters": { "properties": { "endUserMetadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The end user metadata to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).", "type": "object" }, "payload": { "description": "Optional. The payload to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "webhookHeaders": { "description": "Optional. The HTTP headers to be sent as webhook_headers in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).", "type": "object", "additionalProperties": { "type": "string" } } }, "id": "SessionConfigRemoteDialogflowQueryParameters", "description": "[QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters) to send to the remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent when the session control is transferred to the remote agent.", "type": "object" }, "ConversationLoggingSettings": { "id": "ConversationLoggingSettings", "description": "Settings to describe the conversation logging behaviors for the app.", "type": "object", "properties": { "disableConversationLogging": { "description": "Optional. Whether to disable conversation logging for the sessions.", "type": "boolean" }, "retentionWindow": { "description": "Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days.", "type": "string", "format": "google-duration" } } }, "McpToolOverride": { "properties": { "descriptionOverride": { "description": "Optional. If present, this tool uses this description instead of the original description from the server.", "type": "string" }, "tool": { "description": "Required. The original name of the tool as it is emitted by the MCP server.", "type": "string" }, "nameOverride": { "description": "Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools.", "type": "string" }, "snapshot": { "description": "Output only. If present, this tool is \"Pinned\" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present.", "readOnly": true, "$ref": "McpToolDefinition" } }, "id": "McpToolOverride", "description": "Overrides associated with a given tool in a Toolset. This enables \"pinning\" or \"overriding\" of tool definitions from the external dynamic server.", "type": "object" }, "WidgetTool": { "properties": { "name": { "description": "Required. The display name of the widget tool.", "type": "string" }, "description": { "description": "Optional. The description of the widget tool.", "type": "string" }, "dataMapping": { "description": "Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.", "$ref": "WidgetToolDataMapping" }, "parameters": { "description": "Optional. The input parameters of the widget tool.", "$ref": "Schema" }, "uiConfig": { "description": "Optional. Configuration for rendering the widget.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "textResponseConfig": { "description": "Optional. Configuration for always-included text responses.", "$ref": "WidgetToolTextResponseConfig" }, "widgetType": { "enumDescriptions": [ "Unspecified widget type.", "Custom widget type.", "Product carousel widget.", "Product details widget.", "Quick actions widget.", "Product comparison widget.", "Advanced product details widget.", "Short form widget.", "Overall satisfaction widget.", "Order summary widget.", "Appointment details widget.", "Appointment scheduler widget.", "Contact form widget." ], "description": "Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.", "type": "string", "enum": [ "WIDGET_TYPE_UNSPECIFIED", "CUSTOM", "PRODUCT_CAROUSEL", "PRODUCT_DETAILS", "QUICK_ACTIONS", "PRODUCT_COMPARISON", "ADVANCED_PRODUCT_DETAILS", "SHORT_FORM", "OVERALL_SATISFACTION", "ORDER_SUMMARY", "APPOINTMENT_DETAILS", "APPOINTMENT_SCHEDULER", "CONTACT_FORM" ] } }, "id": "WidgetTool", "description": "Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.", "type": "object" }, "McpToolset": { "properties": { "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.", "$ref": "ServiceDirectoryConfig" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust.", "$ref": "TlsConfig" }, "apiAuthentication": { "description": "Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.", "$ref": "ApiAuthentication" }, "customHeaders": { "additionalProperties": { "type": "string" }, "description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.", "type": "object" }, "serverAddress": { "description": "Required. The address of the MCP server, for example, \"https://example.com/mcp/\". If the server is built with the MCP SDK, the url should be suffixed with \"/mcp/\". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.", "type": "string" }, "toolOverrides": { "items": { "$ref": "McpToolOverride" }, "description": "Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic.", "type": "array" } }, "id": "McpToolset", "description": "A toolset that contains a list of tools that are offered by the MCP server.", "type": "object" }, "ErrorHandlingSettings": { "id": "ErrorHandlingSettings", "description": "Settings to describe how errors should be handled in the app.", "type": "object", "properties": { "endSessionConfig": { "description": "Optional. Configuration for ending the session in case of system errors (e.g. LLM errors).", "$ref": "ErrorHandlingSettingsEndSessionConfig" }, "fallbackResponseConfig": { "description": "Optional. Configuration for handling fallback responses.", "$ref": "ErrorHandlingSettingsFallbackResponseConfig" }, "errorHandlingStrategy": { "enumDescriptions": [ "Unspecified error handling strategy.", "No specific handling is enabled.", "A fallback message will be returned to the user in case of system errors (e.g. LLM errors).", "An EndSession signal will be emitted in case of system errors (e.g. LLM errors)." ], "description": "Optional. The strategy to use for error handling.", "type": "string", "enum": [ "ERROR_HANDLING_STRATEGY_UNSPECIFIED", "NONE", "FALLBACK_RESPONSE", "END_SESSION" ] } } }, "LfA2aV1AgentInterface": { "id": "LfA2aV1AgentInterface", "description": "Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.", "type": "object", "properties": { "url": { "description": "Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: \"https://api.example.com/a2a/v1\", \"https://grpc.example.com/a2a\"", "type": "string" }, "tenant": { "description": "Optional. An opaque string used for routing requests to a specific agent or tenant when multiple agents are served behind a single A2A endpoint. When set, clients MUST include this value in the `tenant` field of all request messages sent to this interface. The server is responsible for interpreting the value and routing requests accordingly; the protocol does not define its format or semantics.", "type": "string" }, "protocolBinding": { "description": "Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.", "type": "string" }, "protocolVersion": { "description": "Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: \"0.3\", \"1.0\"", "type": "string" } } }, "MockConfig": { "properties": { "mockedToolCalls": { "description": "Optional. All tool calls to mock for the duration of the session.", "type": "array", "items": { "$ref": "MockedToolCall" } }, "unmatchedToolCallBehavior": { "description": "Required. Beavhior for tool calls that don't match any args patterns in mocked_tool_calls.", "type": "string", "enum": [ "UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED", "FAIL", "PASS_THROUGH" ], "enumDescriptions": [ "Default value. This value is unused.", "Throw an error for any tool calls that don't match a mock expected input pattern.", "For unmatched tool calls, pass the tool call through to real tool." ] } }, "id": "MockConfig", "description": "Mock tool calls configuration for the session.", "type": "object" }, "AgentAgentToolset": { "properties": { "toolIds": { "description": "Optional. The tools IDs to filter the toolset.", "type": "array", "items": { "type": "string" } }, "toolset": { "description": "Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string" } }, "id": "AgentAgentToolset", "description": "A toolset with a selection of its tools.", "type": "object" }, "TriggerActionTransferAgent": { "properties": { "agent": { "description": "Required. The name of the agent to transfer the conversation to. The agent must be in the same app as the current agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" } }, "id": "TriggerActionTransferAgent", "description": "The agent will transfer the conversation to a different agent.", "type": "object" }, "SecuritySettings": { "properties": { "endpointControlPolicy": { "description": "Optional. Endpoint control related settings.", "$ref": "EndpointControlPolicy" }, "createTime": { "description": "Output only. Create time of the security settings.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Last update time of the security settings.", "readOnly": true, "type": "string", "format": "google-datetime" }, "etag": { "description": "Output only. Etag of the security settings.", "readOnly": true, "type": "string" }, "name": { "description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`", "type": "string" } }, "id": "SecuritySettings", "description": "Project/Location level security settings for CES.", "type": "object" }, "RetrieveToolsRequest": { "id": "RetrieveToolsRequest", "description": "Request message for ToolService.RetrieveTools.", "type": "object", "properties": { "toolIds": { "items": { "type": "string" }, "description": "Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned.", "type": "array" }, "bypassPersistenceConfig": { "description": "Optional. If true, the returned tools will contain raw descriptions and schemas directly from the server, bypassing any stored persistence configurations (overrides/snapshots).", "type": "boolean" } } }, "TransferRuleDeterministicTransfer": { "properties": { "expressionCondition": { "description": "Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs.", "$ref": "ExpressionCondition" }, "pythonCodeCondition": { "description": "Optional. A rule that uses Python code block to evaluate the conditions. If the condition evaluates to true, the transfer occurs.", "$ref": "PythonCodeCondition" } }, "id": "TransferRuleDeterministicTransfer", "description": "Deterministic transfer rule. When the condition evaluates to true, the transfer occurs.", "type": "object" }, "FileSearchTool": { "id": "FileSearchTool", "description": "The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results.", "type": "object", "properties": { "name": { "description": "Required. The tool name.", "type": "string" }, "description": { "description": "Optional. The tool description.", "type": "string" }, "corpusType": { "description": "Optional. The type of the corpus. Default is FULLY_MANAGED.", "type": "string", "enum": [ "CORPUS_TYPE_UNSPECIFIED", "USER_OWNED", "FULLY_MANAGED" ], "enumDescriptions": [ "Unspecified corpus type.", "The corpus is created and owned by the user.", "The corpus is created by the agent." ] }, "fileCorpus": { "description": "Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}", "type": "string" } } }, "RetrieveToolSchemaResponse": { "properties": { "tool": { "description": "The name of the tool that the schema is for. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "outputSchema": { "description": "The schema of the tool output parameters.", "$ref": "Schema" }, "toolsetTool": { "description": "The toolset tool that the schema is for.", "$ref": "ToolsetTool" }, "inputSchema": { "description": "The schema of the tool input parameters.", "$ref": "Schema" } }, "id": "RetrieveToolSchemaResponse", "description": "Response message for ToolService.RetrieveToolSchema.", "type": "object" }, "ToolFakeConfig": { "properties": { "enableFakeMode": { "description": "Optional. Whether the tool is using fake mode.", "type": "boolean" }, "codeBlock": { "description": "Optional. Code block which will be executed instead of a real tool call.", "$ref": "CodeBlock" } }, "id": "ToolFakeConfig", "description": "Configuration for tool behavior in fake mode.", "type": "object" }, "ClientFunction": { "properties": { "parameters": { "description": "Optional. The schema of the function parameters.", "$ref": "Schema" }, "response": { "description": "Optional. The schema of the function response.", "$ref": "Schema" }, "name": { "description": "Required. The function name.", "type": "string" }, "description": { "description": "Optional. The function description.", "type": "string" } }, "id": "ClientFunction", "description": "Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent.", "type": "object" }, "ServiceAccountAuthConfig": { "id": "ServiceAccountAuthConfig", "description": "Configurations for authentication using a custom service account.", "type": "object", "properties": { "serviceAccount": { "description": "Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.", "type": "string" }, "scopes": { "items": { "type": "string" }, "description": "Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.", "type": "array" } } }, "EndUserAuthConfig": { "properties": { "oauth2AuthCodeConfig": { "description": "Oauth 2.0 Authorization Code authentication.", "$ref": "EndUserAuthConfigOauth2AuthCodeConfig" }, "oauth2JwtBearerConfig": { "description": "JWT Profile Oauth 2.0 Authorization Grant authentication.", "$ref": "EndUserAuthConfigOauth2JwtBearerConfig" } }, "id": "EndUserAuthConfig", "description": "End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`.", "type": "object" }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds": { "properties": { "semanticSimilaritySuccessThreshold": { "description": "Optional. The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is \u003e= 3.", "type": "integer", "format": "int32" }, "overallToolInvocationCorrectnessThreshold": { "description": "Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.", "type": "number", "format": "float" }, "semanticSimilarityChannel": { "description": "Optional. The semantic similarity channel to use for evaluation.", "type": "string", "enum": [ "SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED", "TEXT", "AUDIO" ], "enumDescriptions": [ "Metric unspecified. Defaults to TEXT.", "Use text semantic similarity.", "Use audio semantic similarity." ] } }, "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds", "description": "Turn level metrics thresholds.", "type": "object" }, "GoogleSearchSuggestions": { "id": "GoogleSearchSuggestions", "description": "Search suggestions from Google Search Tool.", "type": "object", "properties": { "htmls": { "items": { "type": "string" }, "description": "Compliant HTML and CSS styling for search suggestions. The provided HTML and CSS automatically adapts to your device settings, displaying in either light or dark mode indicated by `@media(prefers-color-scheme)`.", "type": "array" }, "webSearchQueries": { "items": { "$ref": "WebSearchQuery" }, "description": "List of queries used to perform the google search along with the search result URIs forming the search suggestions.", "type": "array" } } }, "TriggerActionResponse": { "id": "TriggerActionResponse", "description": "Represents a response from the agent.", "type": "object", "properties": { "text": { "description": "Required. Text for the agent to respond with.", "type": "string" }, "disabled": { "description": "Optional. Whether the response is disabled. Disabled responses are not used by the agent.", "type": "boolean" } } }, "AgentRemoteDialogflowAgent": { "properties": { "agent": { "description": "Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`", "type": "string" }, "flowId": { "description": "Optional. The flow ID of the flow in the Dialogflow agent.", "type": "string" }, "languageCodeVariable": { "description": "Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used.", "type": "string" }, "inputVariableMapping": { "additionalProperties": { "type": "string" }, "description": "Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.", "type": "object" }, "environmentId": { "description": "Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.", "type": "string" }, "respectResponseInterruptionSettings": { "description": "Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent. * If false: all response messages from the Dialogflow agent follow the app-level barge-in settings. * If true: only response messages with [`allow_playback_interruption`](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#text) set to true will be interruptable, all other messages follow the app-level barge-in settings.", "type": "boolean" }, "outputVariableMapping": { "description": "Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.", "type": "object", "additionalProperties": { "type": "string" } } }, "id": "AgentRemoteDialogflowAgent", "description": "The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent.", "type": "object" }, "WidgetToolDataMapping": { "id": "WidgetToolDataMapping", "description": "Configuration for mapping data from a source tool to the widget's input parameters.", "type": "object", "properties": { "fieldMappings": { "description": "Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.", "type": "object", "additionalProperties": { "type": "string" } }, "sourceToolName": { "description": "Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`", "type": "string" }, "mode": { "description": "Optional. The mode of the data mapping.", "type": "string", "enum": [ "MODE_UNSPECIFIED", "FIELD_MAPPING", "PYTHON_SCRIPT" ], "enumDescriptions": [ "Unspecified mode.", "Use the `field_mappings` map for data transformation.", "Use the `python_script` for data transformation." ] }, "pythonScript": { "deprecated": true, "description": "Deprecated: Use `python_function` instead.", "type": "string" }, "pythonFunction": { "description": "Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.", "$ref": "PythonFunction" } } }, "LanguageSettings": { "properties": { "supportedLanguageCodes": { "description": "Optional. List of languages codes supported by the app, in addition to the `default_language_code`.", "type": "array", "items": { "type": "string" } }, "enableMultilingualSupport": { "description": "Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.", "type": "boolean" }, "defaultLanguageCode": { "description": "Optional. The default language code of the app.", "type": "string" }, "fallbackAction": { "description": "Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as \"escalate\" or \"exit\", which triggers an EndSession signal with corresponding metadata to terminate the conversation.", "type": "string", "deprecated": true } }, "id": "LanguageSettings", "description": "Language settings of the app.", "type": "object" }, "LfA2aV1Part": { "properties": { "data": { "description": "Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).", "type": "any" }, "metadata": { "description": "Optional. metadata associated with this part.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "mediaType": { "description": "The `media_type` (MIME type) of the part content (e.g., \"text/plain\", \"application/json\", \"image/png\"). This field is available for all part types.", "type": "string" }, "url": { "description": "A `url` pointing to the file's content.", "type": "string" }, "text": { "description": "The string content of the `text` part.", "type": "string" }, "filename": { "description": "An optional `filename` for the file (e.g., \"document.pdf\").", "type": "string" }, "raw": { "description": "The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.", "type": "string", "format": "byte" } }, "id": "LfA2aV1Part", "description": "`Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).", "type": "object" }, "LfA2aV1OpenIdConnectSecurityScheme": { "properties": { "description": { "description": "An optional description for the security scheme.", "type": "string" }, "openIdConnectUrl": { "description": "Required. The [OpenID Connect Discovery URL](https://openid.net/specs/openid-connect-discovery-1_0.html) for the OIDC provider's metadata.", "type": "string" } }, "id": "LfA2aV1OpenIdConnectSecurityScheme", "description": "Defines a security scheme using OpenID Connect.", "type": "object" }, "OperationMetadata": { "properties": { "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" } }, "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object" }, "RunSessionRequest": { "id": "RunSessionRequest", "description": "Request message for SessionService.RunSession.", "type": "object", "properties": { "config": { "description": "Required. The configuration for the session.", "$ref": "SessionConfig" }, "inputs": { "items": { "$ref": "SessionInput" }, "description": "Required. Inputs for the session.", "type": "array" } } }, "LfA2aV1SendMessageResponse": { "id": "LfA2aV1SendMessageResponse", "description": "Represents the response for the `SendMessage` method.", "type": "object", "properties": { "message": { "description": "A message from the agent.", "$ref": "LfA2aV1Message" }, "task": { "description": "The task created or updated by the message.", "$ref": "LfA2aV1Task" } } }, "SessionOutputDiagnosticInfo": { "id": "SessionOutputDiagnosticInfo", "description": "Contains execution details during the processing.", "type": "object", "properties": { "messages": { "description": "List of the messages that happened during the processing.", "type": "array", "items": { "$ref": "Message" } }, "rootSpan": { "description": "A trace of the entire request processing, represented as a root span. This span can contain nested child spans for specific operations.", "$ref": "Span" } } }, "LfA2aV1TaskPushNotificationConfig": { "properties": { "id": { "description": "The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.", "type": "string" }, "tenant": { "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "type": "string" }, "taskId": { "description": "The ID of the task this configuration is associated with.", "type": "string" }, "url": { "description": "Required. The URL where the notification should be sent.", "type": "string" }, "authentication": { "description": "Authentication information required to send the notification.", "$ref": "LfA2aV1AuthenticationInfo" }, "token": { "description": "A token unique for this task or session.", "type": "string" } }, "id": "LfA2aV1TaskPushNotificationConfig", "description": "A container associating a push notification configuration with a specific task.", "type": "object" }, "LoggingSettings": { "properties": { "unredactedBigqueryExportSettings": { "description": "Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled.", "$ref": "BigQueryExportSettings" }, "unredactedAudioRecordingConfig": { "description": "Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes.", "$ref": "AudioRecordingConfig" }, "metricAnalysisSettings": { "description": "Optional. Settings to describe the conversation data collection behaviors for the LLM analysis pipeline for the app.", "$ref": "MetricAnalysisSettings" }, "cloudLoggingSettings": { "description": "Optional. Settings to describe the Cloud Logging behaviors for the app.", "$ref": "CloudLoggingSettings" }, "bigqueryExportSettings": { "description": "Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig.", "$ref": "BigQueryExportSettings" }, "conversationLoggingSettings": { "description": "Optional. Settings to describe the conversation logging behaviors for the app.", "$ref": "ConversationLoggingSettings" }, "audioRecordingConfig": { "description": "Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig.", "$ref": "AudioRecordingConfig" }, "evaluationAudioRecordingConfig": { "description": "Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions.", "$ref": "AudioRecordingConfig" }, "redactionConfig": { "description": "Optional. Configuration for how sensitive data should be redacted.", "$ref": "RedactionConfig" } }, "id": "LoggingSettings", "description": "Settings to describe the logging behaviors for the app.", "type": "object" }, "ImportAppRequestImportOptions": { "id": "ImportAppRequestImportOptions", "description": "Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data.", "type": "object", "properties": { "validateOnly": { "description": "Optional. Flag for dry-running the import process. If set to true, the import process will only perform validations and will not make any changes to the existing app or create a new one.", "type": "boolean" }, "conflictResolutionStrategy": { "description": "Optional. The strategy to use when resolving conflicts during import.", "type": "string", "enum": [ "CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED", "REPLACE", "OVERWRITE" ], "enumDescriptions": [ "The conflict resolution strategy is unspecified.", "Replace existing data with imported data. If an app with the same `app_id` already exists, its content will be updated based on the imported app. - Resources (App, Agents, Tools, Examples, Guardrails, Toolsets) in the imported app that have the same display name as existing resources will overwrite the existing ones. - Imported resources with new display names will be created. - Existing resources that do not have a matching display name in the imported app will remain untouched.", "Overwrite existing data with imported data. If an app with the same `app_id` already exists, its content will be overwritten with the imported app. - Existing resources (Agents, Tools, Examples, Guardrails, Toolsets) in the app will be deleted. - Imported resources will be created as new resources." ] } } }, "ChannelProfileWebWidgetConfig": { "properties": { "theme": { "enumDescriptions": [ "Unknown theme.", "Light theme.", "Dark theme." ], "description": "Optional. The theme of the web widget.", "type": "string", "enum": [ "THEME_UNSPECIFIED", "LIGHT", "DARK" ] }, "securitySettings": { "description": "Optional. The security settings of the web widget.", "$ref": "ChannelProfileWebWidgetConfigSecuritySettings" }, "modality": { "description": "Optional. The modality of the web widget.", "type": "string", "enum": [ "MODALITY_UNSPECIFIED", "CHAT_AND_VOICE", "VOICE_ONLY", "CHAT_ONLY", "CHAT_VOICE_AND_VIDEO" ], "enumDescriptions": [ "Unknown modality.", "Widget supports both chat and voice input.", "Widget supports only voice input.", "Widget supports only chat input.", "Widget supports chat, voice, and video input." ] }, "webWidgetTitle": { "description": "Optional. The title of the web widget.", "type": "string" } }, "id": "ChannelProfileWebWidgetConfig", "description": "Message for configuration for the web widget.", "type": "object" }, "LfA2aV1SecurityScheme": { "id": "LfA2aV1SecurityScheme", "description": "Defines a security scheme that can be used to secure an agent's endpoints. This is a discriminated union type based on the OpenAPI 3.2 Security Scheme Object. See: https://spec.openapis.org/oas/v3.2.0.html#security-scheme-object", "type": "object", "properties": { "oauth2SecurityScheme": { "description": "OAuth 2.0 authentication.", "$ref": "LfA2aV1OAuth2SecurityScheme" }, "mtlsSecurityScheme": { "description": "Mutual TLS authentication.", "$ref": "LfA2aV1MutualTlsSecurityScheme" }, "apiKeySecurityScheme": { "description": "API key-based authentication.", "$ref": "LfA2aV1APIKeySecurityScheme" }, "httpAuthSecurityScheme": { "description": "HTTP authentication (Basic, Bearer, etc.).", "$ref": "LfA2aV1HTTPAuthSecurityScheme" }, "openIdConnectSecurityScheme": { "description": "OpenID Connect authentication.", "$ref": "LfA2aV1OpenIdConnectSecurityScheme" } } }, "ClientCertificateSettings": { "properties": { "passphrase": { "description": "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}`", "type": "string" }, "tlsCertificate": { "description": "Required. The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.", "type": "string" }, "privateKey": { "description": "Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`", "type": "string" } }, "id": "ClientCertificateSettings", "description": "Settings for custom client certificates.", "type": "object" }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "locations": { "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request.", "type": "array" } } }, "BigQueryExportSettings": { "id": "BigQueryExportSettings", "description": "Settings to describe the BigQuery export behaviors for the app.", "type": "object", "properties": { "enabled": { "description": "Optional. Indicates whether the BigQuery export is enabled.", "type": "boolean" }, "project": { "description": "Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.", "type": "string" }, "dataset": { "description": "Optional. The BigQuery **dataset ID** to export the data to.", "type": "string" } } }, "LfA2aV1DeviceCodeOAuthFlow": { "properties": { "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "scopes": { "description": "Required. The available scopes for the OAuth2 security scheme.", "type": "object", "additionalProperties": { "type": "string" } }, "deviceAuthorizationUrl": { "description": "Required. The device authorization endpoint URL.", "type": "string" }, "tokenUrl": { "description": "Required. The token URL to be used for this flow.", "type": "string" } }, "id": "LfA2aV1DeviceCodeOAuthFlow", "description": "Defines configuration details for the OAuth 2.0 Device Code flow (RFC 8628). This flow is designed for input-constrained devices such as IoT devices, and CLI tools where the user authenticates on a separate device.", "type": "object" }, "AppVersion": { "id": "AppVersion", "description": "In Customer Engagement Suite (CES), an app version is a snapshot of the app at a specific point in time. It is immutable and cannot be modified once created.", "type": "object", "properties": { "displayName": { "description": "Optional. The display name of the app version.", "type": "string" }, "name": { "description": "Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "description": { "description": "Optional. The description of the app version.", "type": "string" }, "snapshot": { "$ref": "AppSnapshot", "description": "Output only. The snapshot of the app when the version is created.", "readOnly": true }, "etag": { "description": "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.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. Timestamp when the app version was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "creator": { "description": "Output only. Email of the user who created the app version.", "readOnly": true, "type": "string" } } }, "LfA2aV1SendMessageRequest": { "id": "LfA2aV1SendMessageRequest", "description": "Represents a request for the `SendMessage` method.", "type": "object", "properties": { "configuration": { "description": "Configuration for the send request.", "$ref": "LfA2aV1SendMessageConfiguration" }, "metadata": { "description": "A flexible key-value map for passing additional context or parameters.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "message": { "description": "Required. The message to send to the agent.", "$ref": "LfA2aV1Message" } } }, "Operation": { "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" } }, "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object" }, "RunSessionResponse": { "id": "RunSessionResponse", "description": "Response message for SessionService.RunSession.", "type": "object", "properties": { "outputs": { "description": "Outputs for the session.", "type": "array", "items": { "$ref": "SessionOutput" } } } }, "ErrorHandlingSettingsFallbackResponseConfig": { "properties": { "maxFallbackAttempts": { "description": "Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.", "type": "integer", "format": "int32" }, "customFallbackMessages": { "description": "Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language).", "type": "object", "additionalProperties": { "type": "string" } } }, "id": "ErrorHandlingSettingsFallbackResponseConfig", "description": "Configuration for handling fallback responses.", "type": "object" }, "LfA2aV1HTTPAuthSecurityScheme": { "properties": { "bearerFormat": { "description": "A hint to the client to identify how the bearer token is formatted (e.g., \"JWT\"). Primarily for documentation purposes.", "type": "string" }, "description": { "description": "An optional description for the security scheme.", "type": "string" }, "scheme": { "description": "Required. The name of the HTTP Authentication scheme to be used in the Authorization header, as defined in RFC7235 (e.g., \"Bearer\"). This value should be registered in the IANA Authentication Scheme registry.", "type": "string" } }, "id": "LfA2aV1HTTPAuthSecurityScheme", "description": "Defines a security scheme using HTTP authentication.", "type": "object" }, "LfA2aV1AgentSkill": { "properties": { "inputModes": { "items": { "type": "string" }, "description": "The set of supported input media types for this skill, overriding the agent's defaults.", "type": "array" }, "outputModes": { "items": { "type": "string" }, "description": "The set of supported output media types for this skill, overriding the agent's defaults.", "type": "array" }, "name": { "description": "Required. A human-readable name for the skill.", "type": "string" }, "description": { "description": "Required. A detailed description of the skill.", "type": "string" }, "examples": { "description": "Example prompts or scenarios that this skill can handle.", "type": "array", "items": { "type": "string" } }, "tags": { "description": "Required. A set of keywords describing the skill's capabilities.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Required. A unique identifier for the agent's skill.", "type": "string" }, "securityRequirements": { "description": "Security schemes necessary for this skill.", "type": "array", "items": { "$ref": "LfA2aV1SecurityRequirement" } } }, "id": "LfA2aV1AgentSkill", "description": "Represents a distinct capability or function that an agent can perform.", "type": "object" }, "VpcScSettings": { "properties": { "allowedOrigins": { "items": { "type": "string" }, "description": "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.", "type": "array" } }, "id": "VpcScSettings", "description": "VPC-SC settings for the app.", "type": "object" }, "Example": { "properties": { "displayName": { "description": "Required. Display name of the example.", "type": "string" }, "description": { "description": "Optional. Human-readable description of the example.", "type": "string" }, "updateTime": { "description": "Output only. Timestamp when the example was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "invalid": { "description": "Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.", "readOnly": true, "type": "boolean" }, "entryAgent": { "description": "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}`", "type": "string" }, "messages": { "items": { "$ref": "Message" }, "description": "Optional. The collection of messages that make up the conversation.", "type": "array" }, "name": { "description": "Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`", "type": "string" }, "etag": { "description": "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.", "type": "string" }, "createTime": { "description": "Output only. Timestamp when the example was created.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "id": "Example", "description": "An example represents a sample conversation between the user and the agent(s).", "type": "object" }, "GuardrailLlmPolicy": { "id": "GuardrailLlmPolicy", "description": "Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.", "type": "object", "properties": { "failOpen": { "description": "Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.", "type": "boolean" }, "prompt": { "description": "Required. Policy prompt.", "type": "string" }, "maxConversationMessages": { "description": "Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.", "type": "integer", "format": "int32" }, "modelSettings": { "description": "Optional. Model settings.", "$ref": "ModelSettings" }, "policyScope": { "description": "Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond.", "type": "string", "enum": [ "POLICY_SCOPE_UNSPECIFIED", "USER_QUERY", "AGENT_RESPONSE", "USER_QUERY_AND_AGENT_RESPONSE" ], "enumDescriptions": [ "Policy scope is not specified.", "Policy check is triggered on user input.", "Policy check is triggered on agent response. Applying this policy scope will introduce additional latency before the agent can respond.", "Policy check is triggered on both user input and agent response. Applying this policy scope will introduce additional latency before the agent can respond." ] }, "allowShortUtterance": { "description": "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.", "type": "boolean" } } }, "ChannelProfilePersonaProperty": { "properties": { "persona": { "description": "Optional. The persona of the channel.", "type": "string", "enum": [ "UNKNOWN", "CONCISE", "CHATTY" ], "enumDescriptions": [ "UNKNOWN persona.", "The agent keeps the responses concise and to the point", "The agent provides additional context, explanations, and details" ] } }, "id": "ChannelProfilePersonaProperty", "description": "Represents the persona property of a channel.", "type": "object" }, "ChannelProfileInstagramConfig": { "properties": { "displayName": { "description": "Output only. The fetched Meta business page name.", "readOnly": true, "type": "string" }, "thumbnailUrl": { "description": "Output only. The fetched Meta business profile thumbnail URL.", "readOnly": true, "type": "string" }, "instagramAccountId": { "description": "Required. The Instagram Account ID.", "type": "string" }, "description": { "description": "Output only. The description of the Meta business page or profile.", "readOnly": true, "type": "string" } }, "id": "ChannelProfileInstagramConfig", "description": "Configuration specific to Instagram deployments.", "type": "object" }, "DataStoreSettings": { "id": "DataStoreSettings", "description": "Data store related settings for the app.", "type": "object", "properties": { "engines": { "description": "Output only. The engines for the app.", "readOnly": true, "type": "array", "items": { "$ref": "DataStoreSettingsEngine" } } } }, "ExperimentConfig": { "id": "ExperimentConfig", "description": "Experiment for the deployment.", "type": "object", "properties": { "versionRelease": { "description": "Optional. Version release for the experiment.", "$ref": "ExperimentConfigVersionRelease" } } }, "Agent": { "id": "Agent", "description": "An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks.", "type": "object", "properties": { "beforeModelCallbacks": { "description": "Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.", "type": "array", "items": { "$ref": "Callback" } }, "instruction": { "description": "Optional. Instructions for the LLM model to guide the agent's behavior.", "type": "string" }, "tools": { "description": "Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "array", "items": { "type": "string" } }, "generatedSummary": { "description": "Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.", "readOnly": true, "type": "string" }, "displayName": { "description": "Required. Display name of the agent.", "type": "string" }, "llmAgent": { "description": "Optional. The default agent type.", "$ref": "AgentLlmAgent" }, "description": { "description": "Optional. Human-readable description of the agent.", "type": "string" }, "remoteDialogflowAgent": { "description": "Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.", "$ref": "AgentRemoteDialogflowAgent" }, "validationErrors": { "description": "Output only. Misconfigurations or errors in the agent that may affect agent quality.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "createTime": { "description": "Output only. Timestamp when the agent was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "toolsets": { "items": { "$ref": "AgentAgentToolset" }, "description": "Optional. List of toolsets for the agent.", "type": "array" }, "afterToolCallbacks": { "items": { "$ref": "Callback" }, "description": "Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.", "type": "array" }, "guardrails": { "description": "Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "type": "array", "items": { "type": "string" } }, "beforeToolCallbacks": { "items": { "$ref": "Callback" }, "description": "Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.", "type": "array" }, "updateTime": { "description": "Output only. Timestamp when the agent was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "childAgents": { "description": "Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "array", "items": { "type": "string" } }, "beforeAgentCallbacks": { "description": "Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.", "type": "array", "items": { "$ref": "Callback" } }, "modelSettings": { "description": "Optional. Configurations for the LLM model.", "$ref": "ModelSettings" }, "afterAgentCallbacks": { "items": { "$ref": "Callback" }, "description": "Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.", "type": "array" }, "etag": { "description": "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.", "type": "string" }, "afterModelCallbacks": { "items": { "$ref": "Callback" }, "description": "Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.", "type": "array" }, "name": { "description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "transferRules": { "items": { "$ref": "TransferRule" }, "description": "Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.", "type": "array" } } }, "RedactionConfig": { "properties": { "deidentifyTemplate": { "description": "Optional. [DLP](https://cloud.google.com/dlp/docs) deidentify template name to instruct on how to de-identify content. Format: `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}`", "type": "string" }, "enableRedaction": { "description": "Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.", "type": "boolean" }, "inspectTemplate": { "description": "Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}`", "type": "string" } }, "id": "RedactionConfig", "description": "Configuration to instruct how sensitive data should be handled.", "type": "object" }, "AgentTransfer": { "id": "AgentTransfer", "description": "Represents an event indicating the transfer of a conversation to a different agent.", "type": "object", "properties": { "targetAgent": { "description": "Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "displayName": { "description": "Output only. Display name of the agent.", "readOnly": true, "type": "string" } } }, "LfA2aV1OAuth2SecurityScheme": { "properties": { "flows": { "description": "Required. An object containing configuration information for the supported OAuth 2.0 flows.", "$ref": "LfA2aV1OAuthFlows" }, "oauth2MetadataUrl": { "description": "URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.", "type": "string" }, "description": { "description": "An optional description for the security scheme.", "type": "string" } }, "id": "LfA2aV1OAuth2SecurityScheme", "description": "Defines a security scheme using OAuth 2.0.", "type": "object" }, "InputAudioConfig": { "id": "InputAudioConfig", "description": "InputAudioConfig configures how the CES agent should interpret the incoming audio data.", "type": "object", "properties": { "sampleRateHertz": { "description": "Required. The sample rate (in Hertz) of the input audio data.", "type": "integer", "format": "int32" }, "audioEncoding": { "description": "Required. The encoding of the input audio data.", "type": "string", "enum": [ "AUDIO_ENCODING_UNSPECIFIED", "LINEAR16", "MULAW", "ALAW" ], "enumDescriptions": [ "Unspecified audio encoding.", "16-bit linear PCM audio encoding.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law." ] }, "noiseSuppressionLevel": { "description": "Optional. Whether to enable noise suppression on the input audio. Available values are \"low\", \"moderate\", \"high\", \"very_high\".", "type": "string" } } }, "GoogleSearchToolPromptConfig": { "properties": { "textPrompt": { "description": "Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.", "type": "string" }, "voicePrompt": { "description": "Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.", "type": "string" } }, "id": "GoogleSearchToolPromptConfig", "description": "Prompt settings used by the model when processing or summarizing the google search results.", "type": "object" }, "RetrieveToolsResponse": { "properties": { "tools": { "items": { "$ref": "Tool" }, "description": "The list of tools that are included in the specified toolset.", "type": "array" } }, "id": "RetrieveToolsResponse", "description": "Response message for ToolService.RetrieveTools.", "type": "object" }, "LfA2aV1AgentCard": { "id": "LfA2aV1AgentCard", "description": "A self-describing manifest for an agent. It provides essential metadata including the agent's identity, capabilities, skills, supported communication methods, and security requirements. Next ID: 20", "type": "object", "properties": { "supportedInterfaces": { "items": { "$ref": "LfA2aV1AgentInterface" }, "description": "Required. Ordered list of supported interfaces. The first entry is preferred.", "type": "array" }, "defaultOutputModes": { "description": "Required. The media types supported as outputs from this agent.", "type": "array", "items": { "type": "string" } }, "documentationUrl": { "description": "A URL providing additional documentation about the agent.", "type": "string" }, "name": { "description": "Required. A human readable name for the agent. Example: \"Recipe Agent\"", "type": "string" }, "skills": { "items": { "$ref": "LfA2aV1AgentSkill" }, "description": "Required. Skills represent the abilities of an agent. It is largely a descriptive concept but represents a more focused set of behaviors that the agent is likely to succeed at.", "type": "array" }, "version": { "description": "Required. The version of the agent. Example: \"1.0.0\"", "type": "string" }, "signatures": { "items": { "$ref": "LfA2aV1AgentCardSignature" }, "description": "JSON Web Signatures computed for this `AgentCard`.", "type": "array" }, "capabilities": { "description": "Required. A2A Capability set supported by the agent.", "$ref": "LfA2aV1AgentCapabilities" }, "description": { "description": "Required. A human-readable description of the agent, assisting users and other agents in understanding its purpose. Example: \"Agent that helps users with recipes and cooking.\"", "type": "string" }, "provider": { "description": "The service provider of the agent.", "$ref": "LfA2aV1AgentProvider" }, "securitySchemes": { "additionalProperties": { "$ref": "LfA2aV1SecurityScheme" }, "description": "The security scheme details used for authenticating with this agent.", "type": "object" }, "securityRequirements": { "items": { "$ref": "LfA2aV1SecurityRequirement" }, "description": "Security requirements for contacting the agent.", "type": "array" }, "defaultInputModes": { "items": { "type": "string" }, "description": "Required. protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as media types.", "type": "array" }, "iconUrl": { "description": "Optional. A URL to an icon for the agent.", "type": "string" } } }, "DataStoreToolSummarizationConfig": { "properties": { "disabled": { "description": "Optional. Whether summarization is disabled.", "type": "boolean" }, "prompt": { "description": "Optional. The prompt definition. If not set, default prompt will be used.", "type": "string" }, "modelSettings": { "description": "Optional. Configurations for the LLM model.", "$ref": "ModelSettings" } }, "id": "DataStoreToolSummarizationConfig", "description": "Summarization configuration.", "type": "object" }, "McpTool": { "id": "McpTool", "description": "An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details.", "type": "object", "properties": { "apiAuthentication": { "description": "Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.", "$ref": "ApiAuthentication" }, "nameOverride": { "description": "Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.", "type": "string" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust.", "$ref": "TlsConfig" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.", "$ref": "ServiceDirectoryConfig" }, "inputSchema": { "description": "Optional. The schema of the input arguments of the MCP tool.", "$ref": "Schema" }, "name": { "description": "Required. The name of the MCP tool.", "type": "string" }, "outputSchema": { "description": "Optional. The schema of the output arguments of the MCP tool.", "$ref": "Schema" }, "serverAddress": { "description": "Required. The server address of the MCP server, e.g., \"https://example.com/mcp/\". If the server is built with the MCP SDK, the url should be suffixed with \"/mcp/\". Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.", "type": "string" }, "description": { "description": "Optional. The description of the MCP tool.", "type": "string" }, "customHeaders": { "additionalProperties": { "type": "string" }, "description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.", "type": "object" }, "state": { "description": "Output only. The dynamic availability state of the tool on the external server.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default state.", "The tool is available and actively offered by the server.", "The tool is configured or pinned, but currently not offered by the server.", "The tool exists on the server, but does not match the version on the server." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "STALE" ] } } }, "LfA2aV1PasswordOAuthFlow": { "properties": { "tokenUrl": { "description": "The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" }, "scopes": { "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" } }, "id": "LfA2aV1PasswordOAuthFlow", "description": "Deprecated: Use Authorization Code + PKCE or Device Code.", "type": "object" }, "Chunk": { "properties": { "blob": { "description": "Optional. Blob data.", "$ref": "Blob" }, "image": { "description": "Optional. Image data.", "$ref": "Image" }, "agentTransfer": { "description": "Optional. Agent transfer event.", "$ref": "AgentTransfer" }, "transcript": { "description": "Optional. Transcript associated with the audio.", "type": "string" }, "payload": { "description": "Optional. Custom payload data.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "toolResponse": { "description": "Optional. Tool execution response.", "$ref": "ToolResponse" }, "updatedVariables": { "description": "A struct represents variables that were updated in the conversation, keyed by variable names.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "defaultVariables": { "description": "A struct represents default variables at the start of the conversation, keyed by variable names.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "toolCall": { "description": "Optional. Tool execution request.", "$ref": "ToolCall" }, "text": { "description": "Optional. Text data.", "type": "string" } }, "id": "Chunk", "description": "A chunk of content within a message.", "type": "object" }, "Empty": { "id": "Empty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {} }, "AgentLlmAgent": { "properties": {}, "id": "AgentLlmAgent", "description": "Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.", "type": "object" }, "ToolResponse": { "properties": { "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "displayName": { "description": "Output only. Display name of the tool.", "readOnly": true, "type": "string" }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Required. The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result.", "type": "object" }, "toolsetTool": { "description": "Optional. The toolset tool that got executed.", "$ref": "ToolsetTool" }, "id": { "description": "Optional. The matching ID of the tool call the response is for.", "type": "string" } }, "id": "ToolResponse", "description": "The execution result of a specific tool from the client or the agent.", "type": "object" }, "ServiceDirectoryConfig": { "properties": { "service": { "description": "Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.", "type": "string" } }, "id": "ServiceDirectoryConfig", "description": "Configuration for tools using Service Directory.", "type": "object" }, "CodeBlock": { "properties": { "pythonCode": { "description": "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) -\u003e Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -\u003e Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.", "type": "string" } }, "id": "CodeBlock", "description": "A code block to be executed instead of a real tool call.", "type": "object" }, "DataStoreToolRewriterConfig": { "properties": { "modelSettings": { "description": "Required. Configurations for the LLM model.", "$ref": "ModelSettings" }, "disabled": { "description": "Optional. Whether the rewriter is disabled.", "type": "boolean" }, "prompt": { "description": "Optional. The prompt definition. If not set, default prompt will be used.", "type": "string" } }, "id": "DataStoreToolRewriterConfig", "description": "Rewriter configuration.", "type": "object" }, "ExportAppRequest": { "id": "ExportAppRequest", "description": "Request message for AgentService.ExportApp.", "type": "object", "properties": { "appVersion": { "description": "Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`.", "type": "string" }, "gcsUri": { "description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified GCS object.", "type": "string" }, "exportFormat": { "description": "Required. The format to export the app in.", "type": "string", "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "enumDescriptions": [ "The export format is unspecified.", "The export format is JSON.", "The export format is YAML." ] } } }, "RetrieveToolSchemaRequest": { "id": "RetrieveToolSchemaRequest", "description": "Request message for ToolService.RetrieveToolSchema.", "type": "object", "properties": { "toolsetTool": { "description": "Optional. The toolset tool to retrieve the schema for. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.", "$ref": "ToolsetTool" }, "tool": { "description": "Optional. The name of the tool to retrieve the schema for. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}", "type": "string" } } }, "EvaluationMetricsThresholdsToolMatchingSettings": { "properties": { "extraToolCallBehavior": { "enumDescriptions": [ "Unspecified behavior. Defaults to FAIL.", "Fail the evaluation if an extra tool call is encountered.", "Allow the extra tool call." ], "description": "Optional. Behavior for extra tool calls. Defaults to FAIL.", "type": "string", "enum": [ "EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED", "FAIL", "ALLOW" ] } }, "id": "EvaluationMetricsThresholdsToolMatchingSettings", "description": "Settings for matching tool calls.", "type": "object" }, "TlsConfig": { "id": "TlsConfig", "description": "The TLS configuration.", "type": "object", "properties": { "caCerts": { "items": { "$ref": "TlsConfigCaCert" }, "description": "Required. Specifies a list of allowed custom CA certificates for HTTPS verification.", "type": "array" } } }, "LfA2aV1MutualTlsSecurityScheme": { "id": "LfA2aV1MutualTlsSecurityScheme", "description": "Defines a security scheme using mTLS authentication.", "type": "object", "properties": { "description": { "description": "An optional description for the security scheme.", "type": "string" } } }, "ImportAppRequest": { "id": "ImportAppRequest", "description": "Request message for AgentService.ImportApp.", "type": "object", "properties": { "appContent": { "description": "Raw bytes representing the compressed zip file with the app folder structure.", "type": "string", "format": "byte" }, "appId": { "description": "Optional. The ID to use for the imported app. * If not specified, a unique ID will be automatically assigned for the app. * Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced.", "type": "string" }, "gcsUri": { "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI from which to import app. The format of this URI must be `gs:///`.", "type": "string" }, "ignoreAppLock": { "description": "Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock.", "type": "boolean" }, "displayName": { "description": "Optional. The display name of the app to import. * If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique. * If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error.", "type": "string" }, "importOptions": { "description": "Optional. Options governing the import process for the app.", "$ref": "ImportAppRequestImportOptions" } } }, "GenerateChatTokenRequest": { "id": "GenerateChatTokenRequest", "description": "Request message for WidgetService.GenerateChatToken.", "type": "object", "properties": { "deployment": { "description": "Required. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}", "type": "string" }, "recaptchaToken": { "description": "Optional. The reCAPTCHA token generated by the client-side chat widget.", "type": "string" }, "liveHandoffEnabled": { "description": "Optional. Indicates if live handoff is enabled for the session.", "type": "boolean" } } }, "Image": { "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp", "type": "string" }, "data": { "description": "Required. Raw bytes of the image.", "type": "string", "format": "byte" } }, "id": "Image", "description": "Represents an image input or output in the conversation.", "type": "object" }, "CancelOperationRequest": { "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {} }, "McpToolDefinition": { "id": "McpToolDefinition", "description": "Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden.", "type": "object", "properties": { "description": { "description": "Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`.", "readOnly": true, "type": "string" }, "inputSchema": { "$ref": "Schema", "description": "Output only. The schema of the input arguments of the MCP tool.", "readOnly": true }, "outputSchema": { "$ref": "Schema", "description": "Output only. The schema of the output arguments of the MCP tool.", "readOnly": true } } } }, "batchPath": "batch", "ownerName": "Google", "name": "ces", "version": "v1", "parameters": { "callback": { "type": "string", "description": "JSONP", "location": "query" }, "$.xgafv": { "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string", "description": "V1 error format." }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "location": "query", "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "prettyPrint": { "default": "true", "location": "query", "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "location": "query", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "enum": [ "json", "media", "proto" ] }, "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." } }, "documentationLink": "https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps", "version_module": true, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, "https://www.googleapis.com/auth/ces": { "description": "Create, update, delete, and manage your Next Gen Agents" } } } }, "fullyEncodeReservedExpansion": true, "discoveryVersion": "v1", "basePath": "", "protocol": "rest", "mtlsRootUrl": "https://ces.mtls.googleapis.com/", "canonicalName": "Customer Engagement Suite", "revision": "20260806", "ownerDomain": "google.com", "kind": "discovery#restDescription", "title": "Gemini Enterprise for Customer Experience API", "baseUrl": "https://ces.googleapis.com/" }