{ "ownerName": "Google", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "discoveryVersion": "v1", "ownerDomain": "google.com", "fullyEncodeReservedExpansion": true, "servicePath": "", "version_module": true, "revision": "20260730", "resources": { "projects": { "resources": { "locations": { "methods": { "updateSecuritySettings": { "parameterOrder": [ "name" ], "description": "Updates the security settings for the project and location.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.updateSecuritySettings", "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "required": true, "description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/securitySettings$" }, "updateMask": { "location": "query", "format": "google-fieldmask", "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" } }, "path": "v1beta/{+name}", "response": { "$ref": "SecuritySettings" }, "request": { "$ref": "SecuritySettings" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/securitySettings" }, "get": { "id": "ces.projects.locations.get", "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Resource name for the location.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location.", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "response": { "$ref": "Location" }, "path": "v1beta/{+name}" }, "getSecuritySettings": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.getSecuritySettings", "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The resource name of the security settings to retrieve. Format: `projects/{project}/locations/{location}/securitySettings`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/securitySettings$" } }, "parameterOrder": [ "name" ], "description": "Retrieves the security settings for the project and location.", "response": { "$ref": "SecuritySettings" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/securitySettings", "path": "v1beta/{+name}" }, "list": { "path": "v1beta/{+name}/locations", "response": { "$ref": "ListLocationsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations", "parameterOrder": [ "name" ], "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.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.list", "httpMethod": "GET", "parameters": { "name": { "description": "The resource that owns the locations collection, if applicable.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+$" }, "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" }, "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "type": "string", "location": "query", "repeated": true }, "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer" }, "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" } } } }, "resources": { "operations": { "methods": { "list": { "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.operations.list", "httpMethod": "GET", "parameters": { "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "type": "string", "required": true }, "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": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" } }, "path": "v1beta/{+name}/operations", "response": { "$ref": "ListOperationsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations" }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "response": { "$ref": "Empty" }, "path": "v1beta/{+name}", "id": "ces.projects.locations.operations.delete", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "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`.", "parameterOrder": [ "name" ] }, "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "response": { "$ref": "Operation" }, "path": "v1beta/{+name}", "id": "ces.projects.locations.operations.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "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.", "parameterOrder": [ "name" ] }, "cancel": { "path": "v1beta/{+name}:cancel", "response": { "$ref": "Empty" }, "request": { "$ref": "CancelOperationRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "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`.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.operations.cancel", "httpMethod": "POST", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } } } } }, "apps": { "methods": { "exportApp": { "path": "v1beta/{+name}:exportApp", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:exportApp", "response": { "$ref": "Operation" }, "request": { "$ref": "ExportAppRequest" }, "description": "Exports the specified app.", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.exportApp", "httpMethod": "POST", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The resource name of the app to export.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "testPersonaVoice": { "description": "Tests the voice of a persona. Also accepts a default persona.", "parameterOrder": [ "app" ], "id": "ces.projects.locations.apps.testPersonaVoice", "httpMethod": "POST", "parameters": { "app": { "description": "Required. the resource name of the app to test the persona voice for. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+app}:testPersonaVoice", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:testPersonaVoice", "response": { "$ref": "TestPersonaVoiceResponse" }, "request": { "$ref": "TestPersonaVoiceRequest" } }, "patch": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.patch", "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "description": "Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "updateMask": { "location": "query", "format": "google-fieldmask", "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" } }, "parameterOrder": [ "name" ], "description": "Updates the specified app.", "request": { "$ref": "App" }, "response": { "$ref": "App" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "path": "v1beta/{+name}" }, "importApp": { "path": "v1beta/{+parent}/apps:importApp", "response": { "$ref": "Operation" }, "request": { "$ref": "ImportAppRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps:importApp", "parameterOrder": [ "parent" ], "description": "Imports the specified app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.importApp", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name with the location of the app to import.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } } }, "importEvaluations": { "path": "v1beta/{+parent}:importEvaluations", "response": { "$ref": "Operation" }, "request": { "$ref": "ImportEvaluationsRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:importEvaluations", "parameterOrder": [ "parent" ], "description": "Imports evaluations into the app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.importEvaluations", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The app to import the evaluations into. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } } }, "generateAppResource": { "request": { "$ref": "GenerateAppResourceRequest" }, "response": { "$ref": "Operation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:generateAppResource", "path": "v1beta/{+parent}:generateAppResource", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.generateAppResource", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The resource name of the app to generate the resource for.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "parameterOrder": [ "parent" ], "description": "Generates specific resources (e.g. agent) in the app using LLM assistant." }, "executeTool": { "id": "ces.projects.locations.apps.executeTool", "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}`", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Executes the given tool with the given arguments.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:executeTool", "request": { "$ref": "ExecuteToolRequest" }, "response": { "$ref": "ExecuteToolResponse" }, "path": "v1beta/{+parent}:executeTool" }, "list": { "id": "ces.projects.locations.apps.list", "httpMethod": "GET", "parameters": { "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" }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListApps call.", "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", "location": "query", "format": "int32" }, "parent": { "required": true, "description": "Required. The resource name of the location to list apps from.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "description": "Optional. Filter to be applied when listing the apps. See https://google.aip.dev/160 for more details.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists apps in the given project and location.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps", "response": { "$ref": "ListAppsResponse" }, "path": "v1beta/{+parent}/apps" }, "create": { "parameterOrder": [ "parent" ], "description": "Creates a new app in the given project and location.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.create", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The resource name of the location to create an app in.", "type": "string", "required": true }, "appId": { "location": "query", "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" } }, "path": "v1beta/{+parent}/apps", "response": { "$ref": "Operation" }, "request": { "$ref": "App" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps" }, "get": { "response": { "$ref": "App" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to retrieve.", "type": "string", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "description": "Gets details of the specified app." }, "runEvaluation": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:runEvaluation", "response": { "$ref": "Operation" }, "request": { "$ref": "RunEvaluationRequest" }, "path": "v1beta/{+app}:runEvaluation", "id": "ces.projects.locations.apps.runEvaluation", "httpMethod": "POST", "parameters": { "app": { "required": true, "description": "Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Runs an evaluation of the app.", "parameterOrder": [ "app" ] }, "retrieveToolSchema": { "id": "ces.projects.locations.apps.retrieveToolSchema", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:retrieveToolSchema", "request": { "$ref": "RetrieveToolSchemaRequest" }, "response": { "$ref": "RetrieveToolSchemaResponse" }, "path": "v1beta/{+parent}:retrieveToolSchema" }, "getExtendedAgentCard": { "description": "Gets the extended agent card for the authenticated agent.", "parameterOrder": [ "tenant" ], "id": "ces.projects.locations.apps.getExtendedAgentCard", "httpMethod": "GET", "parameters": { "tenant": { "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.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+tenant}/extendedAgentCard", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/extendedAgentCard", "response": { "$ref": "LfA2aV1AgentCard" } }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "response": { "$ref": "Operation" }, "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.delete", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the app to delete.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "etag": { "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", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes the specified app.", "parameterOrder": [ "name" ] } }, "resources": { "evaluations": { "methods": { "patch": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}", "request": { "$ref": "Evaluation" }, "response": { "$ref": "Evaluation" }, "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.evaluations.patch", "httpMethod": "PATCH", "parameters": { "name": { "required": true, "description": "Identifier. The unique identifier of this evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$" }, "updateMask": { "location": "query", "format": "google-fieldmask", "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" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an evaluation.", "parameterOrder": [ "name" ] }, "delete": { "id": "ces.projects.locations.apps.evaluations.delete", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "description": "Required. The resource name of the evaluation to delete.", "type": "string", "required": true, "location": "path" }, "force": { "description": "Optional. Indicates whether to forcefully delete the evaluation, even if it is still referenced by evaluation datasets. * If `force = false`, the deletion will fail if any datasets still reference the evaluation. * If `force = true`, all existing references from datasets will be removed and the evaluation will be deleted.", "type": "boolean", "location": "query" }, "etag": { "location": "query", "description": "Optional. The current etag of the evaluation. 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 evaluation, 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" ], "description": "Deletes an evaluation.", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}", "response": { "$ref": "Empty" }, "path": "v1beta/{+name}" }, "create": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations", "request": { "$ref": "Evaluation" }, "response": { "$ref": "Evaluation" }, "path": "v1beta/{+parent}/evaluations", "id": "ces.projects.locations.apps.evaluations.create", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true, "description": "Required. The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "location": "path" }, "evaluationId": { "description": "Optional. The ID to use for the evaluation, which will become the final component of the evaluation's resource name. If not provided, a unique ID will be automatically assigned for the evaluation.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an evaluation.", "parameterOrder": [ "parent" ] }, "list": { "parameterOrder": [ "parent" ], "description": "Lists all evaluations in the given app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluations.list", "httpMethod": "GET", "parameters": { "orderBy": { "location": "query", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\", and \"update_time\" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details.", "type": "string" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.", "type": "string", "location": "query" }, "evaluationFilter": { "location": "query", "description": "Optional. Filter to be applied on the evaluation when listing the evaluations. See https://google.aip.dev/160 for more details. Supported fields: evaluation_datasets", "type": "string" }, "evaluationRunFilter": { "description": "Optional. Filter string for fields on the associated EvaluationRun resources. See https://google.aip.dev/160 for more details. Supported fields: create_time, initiated_by, app_version_display_name", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to list evaluations from.", "type": "string", "required": true, "location": "path" }, "filter": { "location": "query", "deprecated": true, "description": "Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.", "type": "string" }, "lastTenResults": { "description": "Optional. Whether to include the last 10 evaluation results for each evaluation in the response.", "type": "boolean", "location": "query" } }, "path": "v1beta/{+parent}/evaluations", "response": { "$ref": "ListEvaluationsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations" }, "export": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations:export", "request": { "$ref": "ExportEvaluationsRequest" }, "response": { "$ref": "Operation" }, "path": "v1beta/{+parent}/evaluations:export", "id": "ces.projects.locations.apps.evaluations.export", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The resource name of the app to export evaluations from. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Exports evaluations.", "parameterOrder": [ "parent" ] }, "get": { "path": "v1beta/{+name}", "response": { "$ref": "Evaluation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}", "parameterOrder": [ "name" ], "description": "Gets details of the specified evaluation.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluations.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "required": true, "description": "Required. The resource name of the evaluation to retrieve.", "type": "string", "location": "path" } } }, "uploadEvaluationAudio": { "request": { "$ref": "UploadEvaluationAudioRequest" }, "response": { "$ref": "UploadEvaluationAudioResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}:uploadEvaluationAudio", "path": "v1beta/{+name}:uploadEvaluationAudio", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluations.uploadEvaluationAudio", "httpMethod": "POST", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the Evaluation for which to upload the evaluation audio. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$" } }, "parameterOrder": [ "name" ], "description": "Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript." } }, "resources": { "results": { "methods": { "get": { "response": { "$ref": "EvaluationResult" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}", "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluations.results.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$", "location": "path", "description": "Required. The resource name of the evaluation result to retrieve.", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "description": "Gets details of the specified evaluation result." }, "runEvaluationResultMetrics": { "response": { "$ref": "Operation" }, "request": { "$ref": "RunEvaluationResultMetricsRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}:runEvaluationResultMetrics", "path": "v1beta/{+evaluationResultId}:runEvaluationResultMetrics", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluations.results.runEvaluationResultMetrics", "httpMethod": "POST", "parameters": { "evaluationResultId": { "location": "path", "description": "Required. The evaluation result to run metrics for. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result_id}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$" } }, "parameterOrder": [ "evaluationResultId" ], "description": "Runs metrics on an existing evaluation result." }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes an evaluation result.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluations.results.delete", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the evaluation result to delete.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$" } }, "path": "v1beta/{+name}", "response": { "$ref": "Empty" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}" }, "list": { "id": "ces.projects.locations.apps.evaluations.results.list", "httpMethod": "GET", "parameters": { "filter": { "description": "Optional. Filter to be applied when listing the evaluation results. See https://google.aip.dev/160 for more details.", "type": "string", "location": "query" }, "parent": { "location": "path", "required": true, "description": "Required. The resource name of the evaluation to list evaluation results from. To filter by evaluation run, use `-` as the evaluation ID and specify the evaluation run ID in the filter. For example: `projects/{project}/locations/{location}/apps/{app}/evaluations/-`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationResults call.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\", and \"update_time\" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all evaluation results for a given evaluation.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results", "response": { "$ref": "ListEvaluationResultsResponse" }, "path": "v1beta/{+parent}/results" }, "export": { "id": "ces.projects.locations.apps.evaluations.results.export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource name of the evaluation to export evaluation results from. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Exports evaluations results.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results:export", "request": { "$ref": "ExportEvaluationResultsRequest" }, "response": { "$ref": "Operation" }, "path": "v1beta/{+parent}/results:export" } } } } }, "message": { "methods": { "send": { "path": "v1beta/{+tenant}/message:send", "request": { "$ref": "LfA2aV1SendMessageRequest" }, "response": { "$ref": "LfA2aV1SendMessageResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/message:send", "parameterOrder": [ "tenant" ], "description": "Sends a message to an agent.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.message.send", "httpMethod": "POST", "parameters": { "tenant": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "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.", "type": "string", "required": true } } } } }, "sessions": { "methods": { "runSession": { "id": "ces.projects.locations.apps.sessions.runSession", "httpMethod": "POST", "parameters": { "session": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "location": "path", "description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`", "type": "string", "required": true } }, "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.", "parameterOrder": [ "session" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:runSession", "response": { "$ref": "RunSessionResponse" }, "request": { "$ref": "RunSessionRequest" }, "path": "v1beta/{+session}:runSession" }, "streamRunSession": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:streamRunSession", "response": { "$ref": "RunSessionResponse" }, "request": { "$ref": "RunSessionRequest" }, "path": "v1beta/{+session}:streamRunSession", "id": "ces.projects.locations.apps.sessions.streamRunSession", "httpMethod": "POST", "parameters": { "session": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "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.", "parameterOrder": [ "session" ] }, "generateChatToken": { "path": "v1beta/{+name}:generateChatToken", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:generateChatToken", "response": { "$ref": "GenerateChatTokenResponse" }, "request": { "$ref": "GenerateChatTokenRequest" }, "description": "Generates a session scoped token for chat widget to authenticate with Session APIs.", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.sessions.generateChatToken", "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "description": "Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] } } }, "versions": { "methods": { "getExtendedAgentCard": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/extendedAgentCard", "response": { "$ref": "LfA2aV1AgentCard" }, "path": "v1beta/{+tenant}/extendedAgentCard", "id": "ces.projects.locations.apps.versions.getExtendedAgentCard", "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.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the extended agent card for the authenticated agent.", "parameterOrder": [ "tenant" ] }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes the specified app version.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.versions.delete", "httpMethod": "DELETE", "parameters": { "etag": { "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", "location": "query" }, "name": { "location": "path", "description": "Required. The resource name of the app version to delete.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$" } }, "path": "v1beta/{+name}", "response": { "$ref": "Empty" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}" }, "list": { "response": { "$ref": "ListAppVersionsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions", "path": "v1beta/{+parent}/versions", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.versions.list", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource name of the app to list app versions from.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "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" }, "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" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer" }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListAppVersions call.", "type": "string" } }, "parameterOrder": [ "parent" ], "description": "Lists all app versions in the given app." }, "create": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.versions.create", "httpMethod": "POST", "parameters": { "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" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to create an app version in.", "type": "string", "required": true } }, "parameterOrder": [ "parent" ], "description": "Creates a new app version in the given app.", "request": { "$ref": "AppVersion" }, "response": { "$ref": "AppVersion" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions", "path": "v1beta/{+parent}/versions" }, "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}", "response": { "$ref": "AppVersion" }, "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.versions.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "description": "Required. The resource name of the app version to retrieve.", "type": "string", "required": true, "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of the specified app version.", "parameterOrder": [ "name" ] }, "restore": { "parameterOrder": [ "name" ], "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.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.versions.restore", "httpMethod": "POST", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the app version to restore.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$" } }, "path": "v1beta/{+name}:restore", "request": { "$ref": "RestoreAppVersionRequest" }, "response": { "$ref": "Operation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}:restore" } }, "resources": { "message": { "methods": { "send": { "response": { "$ref": "LfA2aV1SendMessageResponse" }, "request": { "$ref": "LfA2aV1SendMessageRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/message:send", "path": "v1beta/{+tenant}/message:send", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.versions.message.send", "httpMethod": "POST", "parameters": { "tenant": { "required": true, "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", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$" } }, "parameterOrder": [ "tenant" ], "description": "Sends a message to an agent." } } } } }, "scheduledEvaluationRuns": { "methods": { "create": { "id": "ces.projects.locations.apps.scheduledEvaluationRuns.create", "httpMethod": "POST", "parameters": { "scheduledEvaluationRunId": { "description": "Optional. The ID to use for the scheduled evaluation run, which will become the final component of the scheduled evaluation run's resource name. If not provided, a unique ID will be automatically assigned.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The app to create the scheduled evaluation run for. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a scheduled evaluation run.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns", "response": { "$ref": "ScheduledEvaluationRun" }, "request": { "$ref": "ScheduledEvaluationRun" }, "path": "v1beta/{+parent}/scheduledEvaluationRuns" }, "list": { "id": "ces.projects.locations.apps.scheduledEvaluationRuns.list", "httpMethod": "GET", "parameters": { "filter": { "location": "query", "description": "Optional. Filter to be applied when listing the scheduled evaluation runs. See https://google.aip.dev/160 for more details. Currently supports filtering by: * request.evaluations:evaluation_id * request.evaluation_dataset:evaluation_dataset_id", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true, "description": "Required. The resource name of the app to list scheduled evaluation runs from.", "type": "string", "location": "path" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer" }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListScheduledEvaluationRuns call.", "type": "string" }, "orderBy": { "description": "Optional. Field to sort by. Supported fields are: \"name\" (ascending), \"create_time\" (descending), \"update_time\" (descending), \"next_scheduled_execution\" (ascending), and \"last_completed_run.create_time\" (descending). If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all scheduled evaluation runs in the given app.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns", "response": { "$ref": "ListScheduledEvaluationRunsResponse" }, "path": "v1beta/{+parent}/scheduledEvaluationRuns" }, "patch": { "id": "ces.projects.locations.apps.scheduledEvaluationRuns.patch", "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$", "description": "Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}", "type": "string", "required": true, "location": "path" }, "updateMask": { "location": "query", "format": "google-fieldmask", "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" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a scheduled evaluation run.", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}", "response": { "$ref": "ScheduledEvaluationRun" }, "request": { "$ref": "ScheduledEvaluationRun" }, "path": "v1beta/{+name}" }, "delete": { "path": "v1beta/{+name}", "response": { "$ref": "Empty" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}", "parameterOrder": [ "name" ], "description": "Deletes a scheduled evaluation run.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.scheduledEvaluationRuns.delete", "httpMethod": "DELETE", "parameters": { "etag": { "location": "query", "description": "Optional. The etag of the ScheduledEvaluationRun. If provided, it must match the server's etag.", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$", "required": true, "description": "Required. The resource name of the scheduled evaluation run to delete.", "type": "string", "location": "path" } } }, "get": { "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}", "response": { "$ref": "ScheduledEvaluationRun" }, "description": "Gets details of the specified scheduled evaluation run.", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.scheduledEvaluationRuns.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$", "description": "Required. The resource name of the scheduled evaluation run to retrieve.", "type": "string", "required": true, "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] } } }, "toolsets": { "methods": { "patch": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}", "request": { "$ref": "Toolset" }, "response": { "$ref": "Toolset" }, "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.toolsets.patch", "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "required": true, "description": "Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string", "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", "location": "query", "format": "google-fieldmask" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the specified toolset.", "parameterOrder": [ "name" ] }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes the specified toolset.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.toolsets.delete", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the toolset to delete.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$" }, "force": { "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", "location": "query" }, "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" } }, "path": "v1beta/{+name}", "response": { "$ref": "Empty" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}" }, "list": { "response": { "$ref": "ListToolsetsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets", "path": "v1beta/{+parent}/toolsets", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.toolsets.list", "httpMethod": "GET", "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" }, "parent": { "location": "path", "description": "Required. The resource name of the app to list toolsets from.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer" }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListToolsets 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" } }, "parameterOrder": [ "parent" ], "description": "Lists toolsets in the given app." }, "create": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets", "request": { "$ref": "Toolset" }, "response": { "$ref": "Toolset" }, "path": "v1beta/{+parent}/toolsets", "id": "ces.projects.locations.apps.toolsets.create", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to create a toolset in.", "type": "string", "required": true, "location": "path" }, "toolsetId": { "location": "query", "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" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new toolset in the given app.", "parameterOrder": [ "parent" ] }, "get": { "description": "Gets details of the specified toolset.", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.toolsets.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "required": true, "description": "Required. The resource name of the toolset to retrieve.", "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}", "response": { "$ref": "Toolset" } }, "retrieveTools": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.toolsets.retrieveTools", "httpMethod": "POST", "parameters": { "toolset": { "required": true, "description": "Required. The name of the toolset to retrieve the tools for. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$" } }, "parameterOrder": [ "toolset" ], "description": "Retrieve the list of tools included in the specified toolset.", "request": { "$ref": "RetrieveToolsRequest" }, "response": { "$ref": "RetrieveToolsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}:retrieveTools", "path": "v1beta/{+toolset}:retrieveTools" } } }, "evaluationDatasets": { "methods": { "get": { "id": "ces.projects.locations.apps.evaluationDatasets.get", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the evaluation dataset to retrieve.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of the specified evaluation dataset.", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}", "response": { "$ref": "EvaluationDataset" }, "path": "v1beta/{+name}" }, "patch": { "path": "v1beta/{+name}", "response": { "$ref": "EvaluationDataset" }, "request": { "$ref": "EvaluationDataset" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}", "parameterOrder": [ "name" ], "description": "Updates an evaluation dataset.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationDatasets.patch", "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$", "required": true, "description": "Identifier. The unique identifier of this evaluation dataset. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "type": "string", "location": "path" }, "updateMask": { "location": "query", "format": "google-fieldmask", "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" } } }, "delete": { "description": "Deletes an evaluation dataset.", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.evaluationDatasets.delete", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "description": "Required. The resource name of the evaluation dataset to delete.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$" }, "etag": { "description": "Optional. The current etag of the evaluation dataset. 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 evaluation dataset, deletion will be blocked and an ABORTED error will be returned.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}", "response": { "$ref": "Empty" } }, "create": { "path": "v1beta/{+parent}/evaluationDatasets", "request": { "$ref": "EvaluationDataset" }, "response": { "$ref": "EvaluationDataset" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets", "parameterOrder": [ "parent" ], "description": "Creates an evaluation dataset.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationDatasets.create", "httpMethod": "POST", "parameters": { "evaluationDatasetId": { "location": "query", "description": "Optional. The ID to use for the evaluation dataset, which will become the final component of the evaluation dataset's resource name. If not provided, a unique ID will be automatically assigned for the evaluation.", "type": "string" }, "parent": { "location": "path", "required": true, "description": "Required. The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } } }, "list": { "response": { "$ref": "ListEvaluationDatasetsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets", "path": "v1beta/{+parent}/evaluationDatasets", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationDatasets.list", "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationDatasets call.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer" }, "orderBy": { "location": "query", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\", and \"update_time\" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details.", "type": "string" }, "filter": { "description": "Optional. Filter to be applied when listing the evaluation datasets. See https://google.aip.dev/160 for more details.", "type": "string", "location": "query" }, "parent": { "location": "path", "required": true, "description": "Required. The resource name of the app to list evaluation datasets from.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "parameterOrder": [ "parent" ], "description": "Lists all evaluation datasets in the given app." } } }, "tools": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.tools.get", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the tool to retrieve.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$" } }, "parameterOrder": [ "name" ], "description": "Gets details of the specified tool.", "response": { "$ref": "Tool" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "path": "v1beta/{+name}" }, "patch": { "parameterOrder": [ "name" ], "description": "Updates the specified tool.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.tools.patch", "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "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", "required": true, "location": "path" }, "updateMask": { "location": "query", "format": "google-fieldmask", "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" } }, "path": "v1beta/{+name}", "request": { "$ref": "Tool" }, "response": { "$ref": "Tool" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}" }, "delete": { "path": "v1beta/{+name}", "response": { "$ref": "Empty" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "parameterOrder": [ "name" ], "description": "Deletes the specified tool.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.tools.delete", "httpMethod": "DELETE", "parameters": { "force": { "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", "location": "query" }, "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": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the tool to delete.", "type": "string" } } }, "list": { "path": "v1beta/{+parent}/tools", "response": { "$ref": "ListToolsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools", "parameterOrder": [ "parent" ], "description": "Lists tools in the given app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.tools.list", "httpMethod": "GET", "parameters": { "filter": { "location": "query", "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" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to list tools from.", "type": "string", "required": true }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListTools call.", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer" }, "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" } } }, "create": { "parameterOrder": [ "parent" ], "description": "Creates a new tool in the given app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.tools.create", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "description": "Required. The resource name of the app to create a tool in.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "toolId": { "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", "location": "query" } }, "path": "v1beta/{+parent}/tools", "request": { "$ref": "Tool" }, "response": { "$ref": "Tool" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools" } } }, "deployments": { "methods": { "getExtendedAgentCard": { "parameterOrder": [ "tenant" ], "description": "Gets the extended agent card for the authenticated agent.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.deployments.getExtendedAgentCard", "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.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$" } }, "path": "v1beta/{+tenant}/extendedAgentCard", "response": { "$ref": "LfA2aV1AgentCard" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/extendedAgentCard" }, "patch": { "description": "Updates the specified deployment.", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.deployments.patch", "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string", "required": true, "location": "path" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to update.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "response": { "$ref": "Deployment" }, "request": { "$ref": "Deployment" } }, "delete": { "path": "v1beta/{+name}", "response": { "$ref": "Empty" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "parameterOrder": [ "name" ], "description": "Deletes the specified deployment.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.deployments.delete", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "required": true, "description": "Required. The name of the deployment to delete. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string", "location": "path" }, "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" } } }, "list": { "id": "ces.projects.locations.apps.deployments.list", "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "required": true, "location": "path" }, "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" }, "pageToken": { "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", "location": "query" }, "pageSize": { "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", "location": "query", "format": "int32" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists deployments in the given app.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments", "response": { "$ref": "ListDeploymentsResponse" }, "path": "v1beta/{+parent}/deployments" }, "create": { "parameterOrder": [ "parent" ], "description": "Creates a new deployment in the given app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.deployments.create", "httpMethod": "POST", "parameters": { "deploymentId": { "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", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "required": true } }, "path": "v1beta/{+parent}/deployments", "response": { "$ref": "Deployment" }, "request": { "$ref": "Deployment" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments" }, "get": { "path": "v1beta/{+name}", "response": { "$ref": "Deployment" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "parameterOrder": [ "name" ], "description": "Gets details of the specified deployment.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.deployments.get", "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. The name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$" } } } }, "resources": { "message": { "methods": { "send": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.deployments.message.send", "httpMethod": "POST", "parameters": { "tenant": { "location": "path", "required": true, "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", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$" } }, "parameterOrder": [ "tenant" ], "description": "Sends a message to an agent.", "response": { "$ref": "LfA2aV1SendMessageResponse" }, "request": { "$ref": "LfA2aV1SendMessageRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/message:send", "path": "v1beta/{+tenant}/message:send" } } } } }, "evaluationRuns": { "methods": { "get": { "path": "v1beta/{+name}", "response": { "$ref": "EvaluationRun" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns/{evaluationRunsId}", "parameterOrder": [ "name" ], "description": "Gets details of the specified evaluation run.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationRuns.get", "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the evaluation run to retrieve.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationRuns/[^/]+$" } } }, "delete": { "response": { "$ref": "Operation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns/{evaluationRunsId}", "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationRuns.delete", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationRuns/[^/]+$", "required": true, "description": "Required. The resource name of the evaluation run to delete.", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "description": "Deletes an evaluation run." }, "list": { "parameterOrder": [ "parent" ], "description": "Lists all evaluation runs in the given app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationRuns.list", "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationRuns call.", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer" }, "orderBy": { "location": "query", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\", and \"update_time\" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details.", "type": "string" }, "filter": { "description": "Optional. Filter to be applied when listing the evaluation runs. See https://google.aip.dev/160 for more details.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to list evaluation runs from.", "type": "string", "required": true, "location": "path" } }, "path": "v1beta/{+parent}/evaluationRuns", "response": { "$ref": "ListEvaluationRunsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns" }, "export": { "response": { "$ref": "Operation" }, "request": { "$ref": "ExportEvaluationRunsRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns:export", "path": "v1beta/{+parent}/evaluationRuns:export", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationRuns.export", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to export evaluation runs from. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "required": true, "location": "path" } }, "parameterOrder": [ "parent" ], "description": "Exports evaluations runs." } } }, "guardrails": { "methods": { "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "response": { "$ref": "Guardrail" }, "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.guardrails.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "location": "path", "description": "Required. The resource name of the guardrail to retrieve.", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of the specified guardrail.", "parameterOrder": [ "name" ] }, "patch": { "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "request": { "$ref": "Guardrail" }, "response": { "$ref": "Guardrail" }, "description": "Updates the specified guardrail.", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.guardrails.patch", "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "description": "Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "type": "string", "required": true, "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", "location": "query", "format": "google-fieldmask" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.guardrails.delete", "httpMethod": "DELETE", "parameters": { "force": { "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", "location": "query" }, "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": { "location": "path", "required": true, "description": "Required. The resource name of the guardrail to delete.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$" } }, "parameterOrder": [ "name" ], "description": "Deletes the specified guardrail.", "response": { "$ref": "Empty" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "path": "v1beta/{+name}" }, "list": { "parameterOrder": [ "parent" ], "description": "Lists guardrails in the given app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.guardrails.list", "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListGuardrails call.", "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", "location": "query", "format": "int32" }, "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 guardrails. See https://google.aip.dev/160 for more details.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the app to list guardrails from.", "type": "string" } }, "path": "v1beta/{+parent}/guardrails", "response": { "$ref": "ListGuardrailsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails" }, "create": { "path": "v1beta/{+parent}/guardrails", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails", "request": { "$ref": "Guardrail" }, "response": { "$ref": "Guardrail" }, "description": "Creates a new guardrail in the given app.", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.guardrails.create", "httpMethod": "POST", "parameters": { "guardrailId": { "location": "query", "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" }, "parent": { "required": true, "description": "Required. The resource name of the app to create a guardrail in.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] } } }, "evaluationExpectations": { "methods": { "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}", "response": { "$ref": "EvaluationExpectation" }, "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.evaluationExpectations.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$", "required": true, "description": "Required. The resource name of the evaluation expectation to retrieve.", "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of the specified evaluation expectation.", "parameterOrder": [ "name" ] }, "list": { "description": "Lists all evaluation expectations in the given app.", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.evaluationExpectations.list", "httpMethod": "GET", "parameters": { "orderBy": { "location": "query", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\", and \"update_time\" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details.", "type": "string" }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationExpectations call.", "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", "location": "query", "format": "int32" }, "parent": { "location": "path", "required": true, "description": "Required. The resource name of the app to list evaluation expectations from.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "filter": { "description": "Optional. Filter to be applied when listing the evaluation expectations. See https://google.aip.dev/160 for more details.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+parent}/evaluationExpectations", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations", "response": { "$ref": "ListEvaluationExpectationsResponse" } }, "create": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationExpectations.create", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "description": "Required. The app to create the evaluation expectation for. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string" }, "evaluationExpectationId": { "description": "Optional. The ID to use for the evaluation expectation, which will become the final component of the evaluation expectation's resource name. If not provided, a unique ID will be automatically assigned for the evaluation expectation.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "description": "Creates an evaluation expectation.", "request": { "$ref": "EvaluationExpectation" }, "response": { "$ref": "EvaluationExpectation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations", "path": "v1beta/{+parent}/evaluationExpectations" }, "patch": { "path": "v1beta/{+name}", "response": { "$ref": "EvaluationExpectation" }, "request": { "$ref": "EvaluationExpectation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}", "parameterOrder": [ "name" ], "description": "Updates an evaluation expectation.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationExpectations.patch", "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$", "location": "path", "required": true, "description": "Identifier. The unique identifier of this evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`", "type": "string" }, "updateMask": { "location": "query", "format": "google-fieldmask", "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" } } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationExpectations.delete", "httpMethod": "DELETE", "parameters": { "etag": { "location": "query", "description": "Optional. The current etag of the evaluation expectation. 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 evaluation expectation, deletion will be blocked and an ABORTED error will be returned.", "type": "string" }, "name": { "description": "Required. The resource name of the evaluation expectation to delete.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$" } }, "parameterOrder": [ "name" ], "description": "Deletes an evaluation expectation.", "response": { "$ref": "Empty" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}", "path": "v1beta/{+name}" } } }, "agents": { "methods": { "get": { "parameterOrder": [ "name" ], "description": "Gets details of the specified agent.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.agents.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "required": true, "description": "Required. The resource name of the agent to retrieve.", "type": "string", "location": "path" } }, "path": "v1beta/{+name}", "response": { "$ref": "Agent" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}" }, "patch": { "parameterOrder": [ "name" ], "description": "Updates the specified agent.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.agents.patch", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$" }, "updateMask": { "location": "query", "format": "google-fieldmask", "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" } }, "path": "v1beta/{+name}", "response": { "$ref": "Agent" }, "request": { "$ref": "Agent" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}" }, "delete": { "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}", "response": { "$ref": "Empty" }, "description": "Deletes the specified agent.", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.agents.delete", "httpMethod": "DELETE", "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": { "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", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "required": true, "description": "Required. The resource name of the agent to delete.", "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "response": { "$ref": "ListAgentsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents", "path": "v1beta/{+parent}/agents", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.agents.list", "httpMethod": "GET", "parameters": { "filter": { "description": "Optional. Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details.", "type": "string", "location": "query" }, "parent": { "location": "path", "description": "Required. The resource name of the app to list agents from.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer" }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListAgents call.", "type": "string" }, "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" } }, "parameterOrder": [ "parent" ], "description": "Lists agents in the given app." }, "create": { "request": { "$ref": "Agent" }, "response": { "$ref": "Agent" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents", "path": "v1beta/{+parent}/agents", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.agents.create", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The resource name of the app to create an agent in.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "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" } }, "parameterOrder": [ "parent" ], "description": "Creates a new agent in the given app." } } }, "examples": { "methods": { "list": { "response": { "$ref": "ListExamplesResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples", "path": "v1beta/{+parent}/examples", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.examples.list", "httpMethod": "GET", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The resource name of the app to list examples from.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "filter": { "description": "Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details.", "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" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListExamples call.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer" } }, "parameterOrder": [ "parent" ], "description": "Lists examples in the given app." }, "create": { "path": "v1beta/{+parent}/examples", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples", "request": { "$ref": "Example" }, "response": { "$ref": "Example" }, "description": "Creates a new example in the given app.", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.examples.create", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource name of the app to create an example in.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "exampleId": { "location": "query", "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" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}", "request": { "$ref": "Example" }, "response": { "$ref": "Example" }, "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.examples.patch", "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "description": "Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$" }, "updateMask": { "location": "query", "format": "google-fieldmask", "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" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the specified example.", "parameterOrder": [ "name" ] }, "delete": { "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}", "response": { "$ref": "Empty" }, "description": "Deletes the specified example.", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.examples.delete", "httpMethod": "DELETE", "parameters": { "etag": { "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", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the example to delete.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.examples.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$", "description": "Required. The resource name of the example to retrieve.", "type": "string", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "description": "Gets details of the specified example.", "response": { "$ref": "Example" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}", "path": "v1beta/{+name}" } } }, "changelogs": { "methods": { "list": { "response": { "$ref": "ListChangelogsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs", "path": "v1beta/{+parent}/changelogs", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.changelogs.list", "httpMethod": "GET", "parameters": { "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "location": "query", "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": { "location": "query", "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" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the app to list changelogs from.", "type": "string" } }, "parameterOrder": [ "parent" ], "description": "Lists the changelogs of the specified app." }, "get": { "path": "v1beta/{+name}", "response": { "$ref": "Changelog" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs/{changelogsId}", "parameterOrder": [ "name" ], "description": "Gets the specified changelog.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.changelogs.get", "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. The resource name of the changelog to retrieve.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/changelogs/[^/]+$" } } } } }, "conversations": { "methods": { "list": { "path": "v1beta/{+parent}/conversations", "response": { "$ref": "ListConversationsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations", "parameterOrder": [ "parent" ], "description": "Lists conversations in the given app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.conversations.list", "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to list conversations from.", "type": "string", "required": true, "location": "path" }, "filter": { "description": "Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details.", "type": "string", "location": "query" }, "sources": { "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "location": "query", "description": "Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default.", "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." ], "repeated": true }, "source": { "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", "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" ], "location": "query" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.", "type": "string", "location": "query" } } }, "generateEvaluation": { "path": "v1beta/{+conversation}:generateEvaluation", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}:generateEvaluation", "request": { "$ref": "GenerateEvaluationRequest" }, "response": { "$ref": "Operation" }, "description": "Creates a golden evaluation from a conversation.", "parameterOrder": [ "conversation" ], "id": "ces.projects.locations.apps.conversations.generateEvaluation", "httpMethod": "POST", "parameters": { "conversation": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$", "required": true, "description": "Required. The conversation to create the golden evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`", "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes the specified conversation.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.conversations.delete", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$", "required": true, "description": "Required. The resource name of the conversation to delete.", "type": "string", "location": "path" }, "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." ], "description": "Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.", "type": "string", "location": "query", "deprecated": true, "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ] } }, "path": "v1beta/{+name}", "response": { "$ref": "Empty" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}" }, "batchDelete": { "description": "Batch deletes the specified conversations.", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.conversations.batchDelete", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true, "description": "Required. The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+parent}/conversations:batchDelete", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations:batchDelete", "response": { "$ref": "Operation" }, "request": { "$ref": "BatchDeleteConversationsRequest" } }, "get": { "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}", "response": { "$ref": "Conversation" }, "description": "Gets details of the specified conversation.", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.conversations.get", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the conversation to retrieve.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$" }, "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." ], "description": "Optional. Indicate the source of the conversation. If not set, all source will be searched.", "type": "string", "location": "query", "deprecated": true, "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ] } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } } } }, "version": "v1beta", "kind": "discovery#restDescription", "canonicalName": "Customer Engagement Suite", "documentationLink": "https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps", "batchPath": "batch", "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" } } } }, "protocol": "rest", "endpoints": [ { "endpointUrl": "https://ces.us.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us" }, { "location": "eu", "endpointUrl": "https://ces.eu.rep.googleapis.com/", "description": "Regional Endpoint" } ], "baseUrl": "https://ces.googleapis.com/", "basePath": "", "schemas": { "LfA2aV1AuthorizationCodeOAuthFlow": { "properties": { "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "authorizationUrl": { "description": "Required. The authorization URL to be used for this flow.", "type": "string" }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Required. The available scopes for the OAuth2 security scheme.", "type": "object" }, "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" }, "tokenUrl": { "description": "Required. The token URL to be used for this flow.", "type": "string" } }, "id": "LfA2aV1AuthorizationCodeOAuthFlow", "description": "Defines configuration details for the OAuth 2.0 Authorization Code flow.", "type": "object" }, "ExportAppResponse": { "description": "Response message for AgentService.ExportApp.", "type": "object", "id": "ExportAppResponse", "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" } } }, "EvaluationExpectationLlmCriteria": { "description": "Configuration for LLM-based evaluation criteria.", "type": "object", "id": "EvaluationExpectationLlmCriteria", "properties": { "prompt": { "description": "Required. The prompt/instructions provided to the LLM judge.", "type": "string" } } }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "type": "object", "id": "CancelOperationRequest", "properties": {} }, "Event": { "properties": { "event": { "description": "Required. The name of the event.", "type": "string" } }, "id": "Event", "description": "Event input.", "type": "object" }, "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" }, "outputModes": { "description": "The set of supported output media types for this skill, overriding the agent's defaults.", "type": "array", "items": { "type": "string" } }, "inputModes": { "items": { "type": "string" }, "description": "The set of supported input 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" }, "tags": { "description": "Required. A set of keywords describing the skill's capabilities.", "type": "array", "items": { "type": "string" } }, "examples": { "description": "Example prompts or scenarios that this skill can handle.", "type": "array", "items": { "type": "string" } } } }, "LfA2aV1SendMessageConfiguration": { "id": "LfA2aV1SendMessageConfiguration", "description": "Configuration of a send message request.", "type": "object", "properties": { "acceptedOutputModes": { "items": { "type": "string" }, "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" }, "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" }, "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" }, "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" } } }, "QualityReportAgentIssues": { "properties": { "agent": { "description": "Optional. The name of the agent to which the issues are related. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "issues": { "items": { "$ref": "QualityReportIssue" }, "description": "Optional. List of issues found for this agent.", "type": "array" } }, "id": "QualityReportAgentIssues", "description": "Issues identified for a single agent.", "type": "object" }, "EvaluationResultGoldenExpectationOutcome": { "properties": { "observedToolCall": { "readOnly": true, "description": "Output only. The result of the tool call expectation.", "$ref": "ToolCall" }, "outcome": { "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "readOnly": true, "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ], "description": "Output only. The outcome of the expectation.", "type": "string" }, "toolInvocationResult": { "readOnly": true, "description": "Output only. The result of the tool invocation check.", "$ref": "EvaluationResultGoldenExpectationOutcomeToolInvocationResult" }, "observedAgentResponse": { "readOnly": true, "description": "Output only. The result of the agent response expectation.", "$ref": "Message" }, "observedPayload": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "readOnly": true, "description": "Output only. An observed custom payload. There are no expectations for custom payloads. This is only used for metrics calculation. The outcome is always SKIPPED.", "type": "object" }, "observedAgentTransfer": { "readOnly": true, "description": "Output only. The result of the agent transfer expectation.", "$ref": "AgentTransfer" }, "expectation": { "readOnly": true, "description": "Output only. The expectation that was evaluated.", "$ref": "EvaluationGoldenExpectation" }, "observedToolResponse": { "description": "Output only. The result of the tool response expectation.", "$ref": "ToolResponse", "readOnly": true }, "semanticSimilarityResult": { "deprecated": true, "readOnly": true, "description": "Output only. The result of the semantic similarity check.", "$ref": "EvaluationResultSemanticSimilarityResult" } }, "description": "Specifies the expectation and the result of that expectation.", "type": "object", "id": "EvaluationResultGoldenExpectationOutcome" }, "LatencyReportCallbackLatency": { "properties": { "stage": { "readOnly": true, "description": "Output only. The stage of the callback.", "type": "string" }, "latencyMetrics": { "description": "Output only. The latency metrics for the callback.", "$ref": "LatencyReportLatencyMetrics", "readOnly": true } }, "id": "LatencyReportCallbackLatency", "description": "Latency metrics for a single callback.", "type": "object" }, "ErrorHandlingSettings": { "id": "ErrorHandlingSettings", "description": "Settings to describe how errors should be handled in the app.", "type": "object", "properties": { "errorHandlingStrategy": { "enum": [ "ERROR_HANDLING_STRATEGY_UNSPECIFIED", "NONE", "FALLBACK_RESPONSE", "END_SESSION" ], "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" }, "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" } } }, "ImportAppRequest": { "properties": { "importOptions": { "description": "Optional. Options governing the import process for the app.", "$ref": "ImportAppRequestImportOptions" }, "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" }, "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" }, "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" }, "appContent": { "description": "Raw bytes representing the compressed zip file with the app folder structure.", "type": "string", "format": "byte" } }, "description": "Request message for AgentService.ImportApp.", "type": "object", "id": "ImportAppRequest" }, "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig": { "description": "The configuration to be used to generate an Open API schema.", "type": "object", "id": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig", "properties": { "uri": { "description": "Required. The base uri of the tool.", "type": "string" }, "operationGenerationConfigs": { "items": { "$ref": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig" }, "description": "Required. The list of operations to be added to the Open API schema.", "type": "array" } } }, "McpTool": { "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" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.", "$ref": "ServiceDirectoryConfig" }, "customHeaders": { "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", "additionalProperties": { "type": "string" } }, "outputSchema": { "description": "Optional. The schema of the output arguments of the MCP tool.", "$ref": "Schema" }, "nameOverride": { "description": "Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.", "type": "string" }, "inputSchema": { "description": "Optional. The schema of the input arguments of the MCP tool.", "$ref": "Schema" }, "description": { "description": "Optional. The description of the MCP tool.", "type": "string" }, "state": { "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "STALE" ], "readOnly": true, "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." ], "description": "Output only. The dynamic availability state of the tool on the external server.", "type": "string" }, "name": { "description": "Required. The name of the MCP tool.", "type": "string" }, "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" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust.", "$ref": "TlsConfig" } }, "description": "An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details.", "type": "object", "id": "McpTool" }, "TriggerAction": { "properties": { "respondImmediately": { "description": "Optional. Immediately respond with a preconfigured response.", "$ref": "TriggerActionRespondImmediately" }, "transferAgent": { "description": "Optional. Transfer the conversation to a different agent.", "$ref": "TriggerActionTransferAgent" }, "generativeAnswer": { "description": "Optional. Respond with a generative answer.", "$ref": "TriggerActionGenerativeAnswer" } }, "description": "Action that is taken when a certain precondition is met.", "type": "object", "id": "TriggerAction" }, "ActionEntityOperation": { "id": "ActionEntityOperation", "description": "Entity CRUD operation specification.", "type": "object", "properties": { "entityId": { "description": "Required. ID of the entity.", "type": "string" }, "operation": { "enum": [ "OPERATION_TYPE_UNSPECIFIED", "LIST", "GET", "CREATE", "UPDATE", "DELETE" ], "description": "Required. Operation to perform on the entity.", "type": "string", "enumDescriptions": [ "Operation type unspecified. Invalid, ConnectorTool create/update will fail.", "List operation.", "Get operation.", "Create operation.", "Update operation.", "Delete operation." ] } } }, "UploadEvaluationAudioResponse": { "description": "Response message for EvaluationService.UploadEvaluationAudio.", "type": "object", "id": "UploadEvaluationAudioResponse", "properties": { "audioGcsUri": { "description": "The Google Cloud Storage URI where the uploaded audio file is stored. Format: `gs:///`", "type": "string" }, "transcript": { "description": "The transcript of the audio, generated by Cloud Speech-to-Text.", "type": "string" }, "duration": { "format": "google-duration", "description": "The duration of the audio.", "type": "string" } } }, "BatchDeleteConversationsResponse": { "id": "BatchDeleteConversationsResponse", "description": "Response message for AgentService.BatchDeleteConversations.", "type": "object", "properties": { "deletedConversations": { "description": "The list of conversations that were successfully deleted.", "type": "array", "items": { "type": "string" } }, "errorMessages": { "description": "Optional. A list of error messages associated with conversations that failed to be deleted.", "type": "array", "items": { "type": "string" } }, "failedConversations": { "items": { "type": "string" }, "description": "The list of conversations that failed to be deleted.", "type": "array" } } }, "EvaluationSettings": { "id": "EvaluationSettings", "description": "Settings for evaluation.", "type": "object", "properties": { "scenarioEvaluationToolCallBehaviour": { "enumDescriptions": [ "Unspecified tool call behavior. Will default to real tool calls.", "Use real tool calls.", "Use fake tool calls." ], "description": "Optional. Configures the default tool call behaviour for scenario evaluations.", "type": "string", "enum": [ "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED", "REAL", "FAKE" ] }, "goldenRunMethod": { "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ], "description": "Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest.", "type": "string", "enumDescriptions": [ "Run method is not specified.", "Run the evaluation as stable replay, where each turn is a unique session with the previous expected turns injected as context.", "Run the evaluation as naive replay, where the run is a single session with no context injected." ] }, "evaluationRunCachingSettings": { "description": "Optional. The caching settings to use for the evaluation run.", "$ref": "EvaluationRunCachingSettings" }, "metricsConfig": { "description": "Optional. Configures the default metrics for evaluations.", "$ref": "EvaluationMetricsConfig" }, "scenarioConversationInitiator": { "enumDescriptions": [ "Unspecified. Defaults to USER.", "The user starts the conversation.", "The agent starts the conversation." ], "description": "Optional. Who starts the conversation in a scenario evaluation.", "type": "string", "enum": [ "SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED", "USER", "AGENT" ] }, "scenarioExecutionMode": { "enum": [ "SCENARIO_EXECUTION_MODE_UNSPECIFIED", "QUALITY_OPTIMIZED", "SPEED_OPTIMIZED" ], "enumDescriptions": [ "Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.", "Quality optimized mode.", "Speed optimized mode." ], "description": "Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED.", "type": "string" }, "goldenEvaluationToolCallBehaviour": { "enumDescriptions": [ "Unspecified tool call behavior. Will default to real tool calls.", "Use real tool calls.", "Use fake tool calls." ], "description": "Optional. Configures the default tool call behaviour for golden evaluations.", "type": "string", "enum": [ "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED", "REAL", "FAKE" ] } } }, "GenerateAppResourceRequestEvaluationGenerationConfig": { "id": "GenerateAppResourceRequestEvaluationGenerationConfig", "description": "The configuration to be used to generate the evaluations.", "type": "object", "properties": { "datasetId": { "description": "Optional. The insights dataset to be used to fetch conversation data for generating the evaluations. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.", "type": "string" } } }, "EvaluationResultGoldenResultTurnReplayResult": { "properties": { "toolCallLatencies": { "readOnly": true, "description": "Output only. The latency of each tool call in the turn.", "type": "array", "items": { "$ref": "EvaluationResultToolCallLatency" } }, "conversation": { "readOnly": true, "description": "Output only. The conversation that was generated for this turn.", "type": "string" }, "spanLatencies": { "description": "Output only. The latency of spans in the turn.", "type": "array", "readOnly": true, "items": { "$ref": "EvaluationResultSpanLatency" } }, "expectationOutcome": { "items": { "$ref": "EvaluationResultGoldenExpectationOutcome" }, "readOnly": true, "description": "Output only. The outcome of each expectation.", "type": "array" }, "overallToolInvocationResult": { "description": "Output only. The result of the overall tool invocation check.", "$ref": "EvaluationResultOverallToolInvocationResult", "readOnly": true }, "toolInvocationScore": { "format": "float", "readOnly": true, "description": "Output only. Deprecated. Use OverallToolInvocationResult instead.", "type": "number", "deprecated": true }, "errorInfo": { "readOnly": true, "description": "Output only. Information about the error that occurred during this turn.", "$ref": "EvaluationErrorInfo" }, "toolOrderedInvocationScore": { "format": "float", "description": "Output only. The overall tool ordered invocation score for this turn. This indicates the overall percent of tools from the expected turn that were actually invoked in the expected order.", "type": "number", "readOnly": true }, "hallucinationResult": { "description": "Output only. The result of the hallucination check.", "$ref": "EvaluationResultHallucinationResult", "readOnly": true }, "semanticSimilarityResult": { "readOnly": true, "description": "Output only. The result of the semantic similarity check.", "$ref": "EvaluationResultSemanticSimilarityResult" }, "turnLatency": { "format": "google-duration", "readOnly": true, "description": "Output only. Duration of the turn.", "type": "string" } }, "id": "EvaluationResultGoldenResultTurnReplayResult", "description": "The result of running a single turn of the golden conversation.", "type": "object" }, "ExpressionCondition": { "id": "ExpressionCondition", "description": "Expression condition based on session state.", "type": "object", "properties": { "expression": { "description": "Required. The string representation of cloud.api.Expression condition.", "type": "string" } } }, "GenerateAppResourceRequestAppGenerationConfig": { "id": "GenerateAppResourceRequestAppGenerationConfig", "description": "The configuration to be used to generate the app.", "type": "object", "properties": { "generateEvaluations": { "description": "Optional. Whether to generate the evaluations for the app. If true, the provided context will be used to generate the evaluations data.", "type": "boolean" }, "fileContexts": { "items": { "$ref": "FileContext" }, "description": "Optional. The files to be used as context.", "type": "array" }, "context": { "description": "Optional. The context which describes the requirements of the agents & tools to be generated.", "type": "string" }, "datasetId": { "description": "Optional. The insights dataset to be used to fetch conversation data for generating the agents & tools. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.", "type": "string" }, "gcsLocation": { "description": "Optional. The Cloud Storage location to store the generated question answer data to be used by the Datastore tool. This data is generated only when using conversation data as an input source. The location must be in the same project as the app. Format: `gs://...`.", "type": "string" } } }, "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": { "format": "int32", "description": "Required. The sample rate (in Hertz) of the output audio data.", "type": "integer" } } }, "Chunk": { "description": "A chunk of content within a message.", "type": "object", "id": "Chunk", "properties": { "updatedVariables": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "A struct represents variables that were updated in the conversation, keyed by variable names.", "type": "object" }, "text": { "description": "Optional. Text data.", "type": "string" }, "toolResponse": { "description": "Optional. Tool execution response.", "$ref": "ToolResponse" }, "payload": { "description": "Optional. Custom payload data.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "agentTransfer": { "description": "Optional. Agent transfer event.", "$ref": "AgentTransfer" }, "toolCall": { "description": "Optional. Tool execution request.", "$ref": "ToolCall" }, "defaultVariables": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "A struct represents default variables at the start of the conversation, keyed by variable names.", "type": "object" }, "blob": { "description": "Optional. Blob data.", "$ref": "Blob" }, "transcript": { "description": "Optional. Transcript associated with the audio.", "type": "string" }, "image": { "description": "Optional. Image data.", "$ref": "Image" } } }, "ImportAppResponse": { "properties": { "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" } }, "name": { "description": "The resource name of the app that was imported.", "type": "string" } }, "description": "Response message for AgentService.ImportApp.", "type": "object", "id": "ImportAppResponse" }, "LfA2aV1SecurityRequirement": { "description": "Defines the security requirements for an agent.", "type": "object", "id": "LfA2aV1SecurityRequirement", "properties": { "schemes": { "additionalProperties": { "$ref": "LfA2aV1StringList" }, "description": "A map of security schemes to the required scopes.", "type": "object" } } }, "WidgetToolTextResponseConfig": { "description": "Configuration for the text response returned with the widget.", "type": "object", "id": "WidgetToolTextResponseConfig", "properties": { "staticText": { "description": "Optional. The static text response to return when type is STATIC.", "type": "string" }, "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" }, "type": { "enum": [ "TYPE_UNSPECIFIED", "NONE", "LLM_GENERATED", "STATIC" ], "description": "Optional. The strategy for providing the text response.", "type": "string", "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." ] } } }, "DeleteEvaluationRunOperationMetadata": { "properties": {}, "id": "DeleteEvaluationRunOperationMetadata", "description": "Operation metadata for EvaluationService.DeleteEvaluationRun.", "type": "object" }, "GenerateAppResourceResponseAppResources": { "properties": { "evaluations": { "items": { "$ref": "Evaluation" }, "description": "The list of evaluations generated by the LLM assistant.", "type": "array" }, "appSnapshot": { "description": "The app snapshot generated by the LLM assistant. This snapshot contains the app, agents & tools generated by the LLM assistant.", "$ref": "AppSnapshot" } }, "description": "The list of app resources generated by the LLM assistant.", "type": "object", "id": "GenerateAppResourceResponseAppResources" }, "Changelog": { "id": "Changelog", "description": "Changelogs represent a change made to the app or to an resource within the app.", "type": "object", "properties": { "sequenceNumber": { "format": "int64", "readOnly": true, "description": "Output only. The monotonically increasing sequence number of the changelog.", "type": "string" }, "resourceType": { "description": "Output only. The type of the resource that was changed.", "type": "string", "readOnly": true }, "name": { "description": "Identifier. The unique identifier of the changelog. Format: `projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}`", "type": "string" }, "resource": { "description": "Output only. The resource that was changed.", "type": "string", "readOnly": true }, "newResource": { "description": "Output only. The new resource after the change.", "type": "object", "readOnly": true, "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "description": { "readOnly": true, "description": "Output only. Description of the change. which typically captures the changed fields in the resource.", "type": "string" }, "action": { "readOnly": true, "description": "Output only. The action that was performed on the resource.", "type": "string" }, "author": { "readOnly": true, "description": "Output only. Email address of the change author.", "type": "string" }, "originalResource": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "readOnly": true, "description": "Output only. The original resource before the change.", "type": "object" }, "dependentResources": { "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "readOnly": true, "description": "Output only. The dependent resources that were changed.", "type": "array" }, "createTime": { "description": "Output only. The time when the change was made.", "type": "string", "readOnly": true, "format": "google-datetime" }, "displayName": { "readOnly": true, "description": "Output only. Display name of the change. It typically should be the display name of the resource that was changed.", "type": "string" } } }, "EvaluationGoldenTurn": { "properties": { "rootSpan": { "description": "Optional. The root span of the golden turn for processing and maintaining audio information. The uri for the audio must contain audio saved in 16Khz sample rate.", "$ref": "Span" }, "turnLevelMetricsThresholdsOverride": { "description": "Optional. Overrides for turn-level metric thresholds.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds" }, "hallucinationMetricBehaviorOverride": { "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ], "description": "Optional. Override for turn-level hallucination metric behavior.", "type": "string" }, "steps": { "description": "Required. The steps required to replay a golden conversation.", "type": "array", "items": { "$ref": "EvaluationStep" } } }, "description": "A golden turn defines a single turn in a golden conversation.", "type": "object", "id": "EvaluationGoldenTurn" }, "AggregatedMetricsHallucinationMetrics": { "id": "AggregatedMetricsHallucinationMetrics", "description": "Metrics for hallucination results.", "type": "object", "properties": { "score": { "readOnly": true, "description": "Output only. The average hallucination score (0 to 1).", "type": "number", "format": "float" } } }, "EvaluationGoldenExpectation": { "description": "Represents a single, checkable requirement.", "type": "object", "id": "EvaluationGoldenExpectation", "properties": { "agentResponse": { "description": "Optional. Check that the agent responded with the correct response. The role \"agent\" is implied.", "$ref": "Message" }, "expectationLevelMetricsThresholdsOverride": { "description": "Optional. Overrides metrics at the step level.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds" }, "agentResponseHallucinationMetricsConfigOverride": { "description": "Optional. Overrides for agent_response hallucination metrics.", "$ref": "EvaluationMetricsConfigHallucinationMetricsConfig" }, "skipEvaluation": { "description": "Optional. If set to true, this specific expectation will not be evaluated.", "type": "boolean" }, "updatedVariables": { "description": "Optional. Check that the agent updated the session variables to the expected values. Used to also capture agent variable updates for golden evals.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "note": { "description": "Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., \"Check_Payment_Tool_Called\".", "type": "string" }, "toolResponse": { "description": "Optional. Check that a specific tool had the expected response.", "$ref": "ToolResponse" }, "agentTransfer": { "description": "Optional. Check that the agent transferred the conversation to a different agent.", "$ref": "AgentTransfer" }, "toolCall": { "description": "Optional. Check that a specific tool was called with the parameters.", "$ref": "ToolCall" }, "comparisonType": { "enum": [ "COMPARISON_TYPE_UNSPECIFIED", "EQUALS", "CONTAINS", "SEMANTIC_SIMILARITY" ], "description": "Optional. The comparison type to use for the expectation check.", "type": "string", "enumDescriptions": [ "Unspecified comparison type. Behavior defaults to SEMANTIC_SIMILARITY for agent responses and tool calls.", "Exact string match.", "Substring match (checks if the expected string is contained in the actual response).", "Semantic similarity match (evaluates meaning similarity using an LLM)." ] }, "agentResponseSemanticSimilarityMetricsConfigOverride": { "description": "Optional. Overrides for agent_response semantic similarity metrics.", "$ref": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig" }, "noToolCalls": { "description": "Optional. Check that no tools were called during this turn.", "type": "boolean" }, "mockToolResponse": { "description": "Optional. The tool response to mock, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM.", "$ref": "ToolResponse" } } }, "LatencyReportLatencyMetrics": { "description": "Latency metrics for a component.", "type": "object", "id": "LatencyReportLatencyMetrics", "properties": { "p50Latency": { "description": "Output only. The 50th percentile latency.", "type": "string", "readOnly": true, "format": "google-duration" }, "callCount": { "format": "int32", "description": "Output only. The number of times the resource was called.", "type": "integer", "readOnly": true }, "p99Latency": { "format": "google-duration", "description": "Output only. The 99th percentile latency.", "type": "string", "readOnly": true }, "p90Latency": { "readOnly": true, "description": "Output only. The 90th percentile latency.", "type": "string", "format": "google-duration" } } }, "LfA2aV1ClientCredentialsOAuthFlow": { "description": "Defines configuration details for the OAuth 2.0 Client Credentials flow.", "type": "object", "id": "LfA2aV1ClientCredentialsOAuthFlow", "properties": { "tokenUrl": { "description": "Required. The token URL to be used for this flow.", "type": "string" }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Required. The available scopes for the OAuth2 security scheme.", "type": "object" }, "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens.", "type": "string" } } }, "DataStoreToolGroundingConfig": { "description": "Grounding configuration.", "type": "object", "id": "DataStoreToolGroundingConfig", "properties": { "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" }, "disabled": { "description": "Optional. Whether grounding is disabled.", "type": "boolean" } } }, "ListAppsResponse": { "properties": { "apps": { "description": "The list of apps.", "type": "array", "items": { "$ref": "App" } }, "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" } } }, "id": "ListAppsResponse", "description": "Response message for AgentService.ListApps.", "type": "object" }, "LfA2aV1Part": { "properties": { "text": { "description": "The string content of the `text` part.", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. metadata associated with this part.", "type": "object" }, "raw": { "format": "byte", "description": "The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.", "type": "string" }, "filename": { "description": "An optional `filename` for the file (e.g., \"document.pdf\").", "type": "string" }, "url": { "description": "A `url` pointing to the file's content.", "type": "string" }, "data": { "description": "Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).", "type": "any" }, "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" } }, "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", "id": "LfA2aV1Part" }, "ExperimentConfigVersionRelease": { "properties": { "trafficAllocations": { "description": "Optional. Traffic allocations for the version release.", "type": "array", "items": { "$ref": "ExperimentConfigVersionReleaseTrafficAllocation" } }, "state": { "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "DONE", "EXPIRED" ], "description": "Optional. State of the version release.", "type": "string", "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." ] } }, "id": "ExperimentConfigVersionRelease", "description": "Version release for the experiment.", "type": "object" }, "VpcScSettings": { "description": "VPC-SC settings for the app.", "type": "object", "id": "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" } } }, "MockConfig": { "properties": { "mockedToolCalls": { "description": "Optional. All tool calls to mock for the duration of the session.", "type": "array", "items": { "$ref": "MockedToolCall" } }, "unmatchedToolCallBehavior": { "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." ], "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" ] } }, "id": "MockConfig", "description": "Mock tool calls configuration for the session.", "type": "object" }, "AppSnapshot": { "id": "AppSnapshot", "description": "A snapshot of the app.", "type": "object", "properties": { "guardrails": { "description": "Optional. List of guardrails in the app.", "type": "array", "items": { "$ref": "Guardrail" } }, "toolsets": { "description": "Optional. List of toolsets in the app.", "type": "array", "items": { "$ref": "Toolset" } }, "app": { "description": "Optional. The basic settings for the app.", "$ref": "App" }, "tools": { "description": "Optional. List of tools in the app.", "type": "array", "items": { "$ref": "Tool" } }, "agents": { "description": "Optional. List of agents in the app.", "type": "array", "items": { "$ref": "Agent" } }, "examples": { "items": { "$ref": "Example" }, "description": "Optional. List of examples in the app.", "type": "array" } } }, "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", "id": "LfA2aV1AgentInterface", "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" }, "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" }, "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" }, "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" } } }, "PersonaRunConfig": { "description": "Configuration for running an evaluation for a specific persona.", "type": "object", "id": "PersonaRunConfig", "properties": { "persona": { "description": "Optional. The persona to use for the evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`", "type": "string" }, "taskCount": { "format": "int32", "description": "Optional. The number of tasks to run for the persona.", "type": "integer" } } }, "LfA2aV1SecurityScheme": { "properties": { "apiKeySecurityScheme": { "description": "API key-based authentication.", "$ref": "LfA2aV1APIKeySecurityScheme" }, "mtlsSecurityScheme": { "description": "Mutual TLS authentication.", "$ref": "LfA2aV1MutualTlsSecurityScheme" }, "httpAuthSecurityScheme": { "description": "HTTP authentication (Basic, Bearer, etc.).", "$ref": "LfA2aV1HTTPAuthSecurityScheme" }, "oauth2SecurityScheme": { "description": "OAuth 2.0 authentication.", "$ref": "LfA2aV1OAuth2SecurityScheme" }, "openIdConnectSecurityScheme": { "description": "OpenID Connect authentication.", "$ref": "LfA2aV1OpenIdConnectSecurityScheme" } }, "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" }, "AgentCard": { "properties": { "description": { "description": "Required. A description of the agent's domain of action/solution space.", "type": "string" }, "version": { "description": "Required. The version of the agent.", "type": "string" }, "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" }, "supportedInterfaces": { "description": "Required. Ordered list of supported interfaces. The first entry is preferred.", "type": "array", "items": { "$ref": "AgentInterface" } }, "name": { "description": "Required. A human-readable name for the agent.", "type": "string" } }, "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", "id": "AgentCard" }, "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": { "messageId": { "description": "Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.", "type": "string" }, "role": { "description": "Required. Identifies the sender of the message.", "type": "string", "enumDescriptions": [ "The role is unspecified.", "The message is from the client to the server.", "The message is from the server to the client." ], "enum": [ "ROLE_UNSPECIFIED", "ROLE_USER", "ROLE_AGENT" ] }, "taskId": { "description": "Optional. The task id of the message. If set, the message will be associated with the given task.", "type": "string" }, "metadata": { "description": "Optional. Any metadata to provide along with the message.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "parts": { "items": { "$ref": "LfA2aV1Part" }, "description": "Required. Parts is the container of the message content.", "type": "array" }, "extensions": { "items": { "type": "string" }, "description": "The URIs of extensions that are present or contributed to this Message.", "type": "array" }, "contextId": { "description": "Optional. The context id of the message. If set, the message will be associated with the given context.", "type": "string" }, "referenceTaskIds": { "description": "A list of task IDs that this message references for additional context.", "type": "array", "items": { "type": "string" } } } }, "AgentAgentToolset": { "properties": { "toolset": { "description": "Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string" }, "toolIds": { "items": { "type": "string" }, "description": "Optional. The tools IDs to filter the toolset.", "type": "array" } }, "description": "A toolset with a selection of its tools.", "type": "object", "id": "AgentAgentToolset" }, "QualityReport": { "properties": { "evaluationRuns": { "items": { "type": "string" }, "description": "Optional. A list of evaluation runs used to generate the quality report. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluationRun}`.", "type": "array" }, "generalIssues": { "items": { "$ref": "QualityReportIssue" }, "description": "Optional. General issues not specific to any agent.", "type": "array" }, "issues": { "description": "Optional. The issues grouped by agent.", "type": "array", "items": { "$ref": "QualityReportAgentIssues" } } }, "id": "QualityReport", "description": "The report describing any identified quality issues in the app.", "type": "object" }, "ChannelProfilePersonaProperty": { "id": "ChannelProfilePersonaProperty", "description": "Represents the persona property of a channel.", "type": "object", "properties": { "persona": { "enumDescriptions": [ "UNKNOWN persona.", "The agent keeps the responses concise and to the point", "The agent provides additional context, explanations, and details" ], "description": "Optional. The persona of the channel.", "type": "string", "enum": [ "UNKNOWN", "CONCISE", "CHATTY" ] } } }, "ExportEvaluationRunsResponse": { "properties": { "evaluationRunsContent": { "description": "The content of the exported Evaluation Runs. This will be populated if gcs_uri was not specified in the request.", "type": "string", "format": "byte" }, "evaluationRunsUri": { "description": "The Google Cloud Storage URI folder where the exported Evaluation Runs were written. This will be populated if gcs_uri was specified in the request.", "type": "string" } }, "id": "ExportEvaluationRunsResponse", "description": "Response message for EvaluationService.ExportEvaluationRuns.", "type": "object" }, "SessionOutput": { "properties": { "turnIndex": { "format": "int32", "description": "Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.", "type": "integer" }, "context": { "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "description": "Context messages for external supervision guardrails.", "type": "array" }, "endSession": { "description": "Indicates the session has ended.", "$ref": "EndSession" }, "googleSearchSuggestions": { "description": "The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.", "$ref": "GoogleSearchSuggestions" }, "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" }, "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" }, "audio": { "description": "Output audio from the CES agent.", "type": "string", "format": "byte" }, "toolCalls": { "description": "Request for the client to execute the tools.", "$ref": "ToolCalls" }, "payload": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Custom payload with structured output from the CES agent.", "type": "object" }, "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" } }, "description": "Output for the session.", "type": "object", "id": "SessionOutput" }, "LoggingSettings": { "id": "LoggingSettings", "description": "Settings to describe the logging behaviors for the app.", "type": "object", "properties": { "cloudLoggingSettings": { "description": "Optional. Settings to describe the Cloud Logging behaviors for the app.", "$ref": "CloudLoggingSettings" }, "audioRecordingConfig": { "description": "Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig.", "$ref": "AudioRecordingConfig" }, "bigqueryExportSettings": { "description": "Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig.", "$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" }, "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" }, "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" }, "conversationLoggingSettings": { "description": "Optional. Settings to describe the conversation logging behaviors for the app.", "$ref": "ConversationLoggingSettings" } } }, "EvaluationResultGoldenExpectationOutcomeToolInvocationResult": { "properties": { "outcome": { "description": "Output only. The outcome of the tool invocation check. This is determined by comparing the parameter_correctness_score to the threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.", "type": "string", "readOnly": true, "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ], "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ] }, "parameterCorrectnessScore": { "format": "float", "description": "Output only. The tool invocation parameter correctness score. This indicates the percent of parameters from the expected tool call that were also present in the actual tool call.", "type": "number", "readOnly": true }, "explanation": { "readOnly": true, "description": "Output only. A free text explanation for the tool invocation result.", "type": "string" } }, "id": "EvaluationResultGoldenExpectationOutcomeToolInvocationResult", "description": "The result of the tool invocation check.", "type": "object" }, "GenerateAppResourceRequestQualityReportGenerationConfig": { "id": "GenerateAppResourceRequestQualityReportGenerationConfig", "description": "The configuration to be used for quality report generation.", "type": "object", "properties": { "evaluationRun": { "description": "Required. The evaluation run used to inform quality report analysis.", "type": "string" }, "algorithm": { "enum": [ "LOSS_ATTRIBUTION_ALGORITHM_UNSPECIFIED", "APP_CENTRIC", "AGENT_CENTRIC" ], "description": "Optional. The loss attribution algorithm to use.", "type": "string", "enumDescriptions": [ "Unspecified.", "App-centric loss attribution. Treats the app as a single unit.", "Agent-centric loss attribution. Attributes loss to individual agents." ] } } }, "EvaluationMetricsConfigToolCorrectnessMetricsConfig": { "properties": { "enableToolCorrectnessMetrics": { "description": "Optional. Whether to calculate tool correctness metrics for the evaluation.", "type": "boolean" } }, "id": "EvaluationMetricsConfigToolCorrectnessMetricsConfig", "description": "Configuration for correctness metrics for the evaluation. To disable the metric, set the message but do not set the `enable_tool_correctness_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", "type": "object" }, "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec": { "properties": { "interpolationType": { "description": "Optional. The interpolation type to be applied to connect the control points listed below.", "type": "string", "enumDescriptions": [ "Interpolation type is unspecified. In this case, it defaults to Linear.", "Piecewise linear interpolation will be applied." ], "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" } }, "fieldName": { "description": "Optional. The name of the field whose value will be used to determine the boost amount.", "type": "string" }, "attributeType": { "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`." ], "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" ] } }, "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" }, "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" } } }, "EvaluationMetricsConfigExpectationsMetMetricsConfig": { "id": "EvaluationMetricsConfigExpectationsMetMetricsConfig", "description": "Configuration for the expectation level metrics for the evaluation. To disable the metric, set the message but do not set the `enable_expectations_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", "type": "object", "properties": { "enableExpectationsMetMetrics": { "description": "Optional. Whether to calculate the expectation level metrics for the evaluation.", "type": "boolean" } } }, "ListEvaluationExpectationsResponse": { "properties": { "evaluationExpectations": { "description": "The list of evaluation expectations.", "type": "array", "items": { "$ref": "EvaluationExpectation" } }, "nextPageToken": { "description": "A token that can be sent as ListEvaluationExpectationsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } }, "id": "ListEvaluationExpectationsResponse", "description": "Response message for EvaluationService.ListEvaluationExpectations.", "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" } }, "description": "Settings to describe the conversation data collection behaviors for LLM analysis metrics pipeline.", "type": "object", "id": "MetricAnalysisSettings" }, "TlsConfigCaCert": { "description": "The CA certificate.", "type": "object", "id": "TlsConfigCaCert", "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": { "format": "byte", "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" } } }, "LatencyReportGuardrailLatency": { "properties": { "latencyMetrics": { "description": "Output only. The latency metrics for the guardrail.", "$ref": "LatencyReportLatencyMetrics", "readOnly": true }, "guardrailDisplayName": { "description": "Output only. The display name of the guardrail.", "type": "string", "readOnly": true }, "guardrail": { "readOnly": true, "description": "Output only. The name of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`.", "type": "string" } }, "id": "LatencyReportGuardrailLatency", "description": "Latency metrics for a single guardrail.", "type": "object" }, "OptimizationConfig": { "properties": { "shouldSuggestFix": { "description": "Output only. Whether to suggest a fix for the losses.", "type": "boolean", "readOnly": true }, "reportSummary": { "readOnly": true, "description": "Output only. The summary of the loss report.", "type": "string" }, "assistantSession": { "description": "Output only. The assistant session to use for the optimization based on this evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}`", "type": "string", "readOnly": true }, "lossReport": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Output only. The generated loss report.", "type": "object", "readOnly": true }, "status": { "readOnly": true, "enumDescriptions": [ "Optimization status is not specified.", "Optimization is running.", "Optimization has completed.", "Optimization failed due to an internal error." ], "description": "Output only. The status of the optimization run.", "type": "string", "enum": [ "OPTIMIZATION_STATUS_UNSPECIFIED", "RUNNING", "COMPLETED", "ERROR" ] }, "errorMessage": { "description": "Output only. The error message if the optimization run failed.", "type": "string", "readOnly": true }, "generateLossReport": { "description": "Optional. Whether to generate a loss report.", "type": "boolean" } }, "description": "Configuration for running the optimization step after the evaluation run.", "type": "object", "id": "OptimizationConfig" }, "LfA2aV1AgentCapabilities": { "properties": { "streaming": { "description": "Indicates if the agent supports streaming responses.", "type": "boolean" }, "extendedAgentCard": { "description": "Indicates if the agent supports providing an extended agent card when authenticated.", "type": "boolean" }, "pushNotifications": { "description": "Indicates if the agent supports sending push notifications for asynchronous task updates.", "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" }, "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": { "conflictResolutionStrategy": { "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." ], "description": "Optional. The strategy to use when resolving conflicts during import.", "type": "string", "enum": [ "CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED", "REPLACE", "OVERWRITE" ] }, "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" } } }, "EndSession": { "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", "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." } } } }, "GenerateAppResourceRequestEvaluationPersonasGenerationConfig": { "properties": {}, "description": "The configuration to be used to generate the evaluation personas.", "type": "object", "id": "GenerateAppResourceRequestEvaluationPersonasGenerationConfig" }, "Image": { "description": "Represents an image input or output in the conversation.", "type": "object", "id": "Image", "properties": { "data": { "description": "Required. Raw bytes of the image.", "type": "string", "format": "byte" }, "mimeType": { "description": "Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp", "type": "string" } } }, "ImportEvaluationsResponse": { "properties": { "errorMessages": { "items": { "type": "string" }, "description": "Optional. A list of error messages associated with evaluations that failed to be imported.", "type": "array" }, "evaluations": { "description": "The list of evaluations that were imported into the app.", "type": "array", "items": { "$ref": "Evaluation" } }, "importFailureCount": { "description": "The number of evaluations that either failed to import entirely or completed import with one or more errors.", "type": "integer", "format": "int32" }, "evaluationRuns": { "description": "The list of evaluation runs that were imported into the app.", "type": "array", "items": { "$ref": "EvaluationRun" } }, "evaluationResults": { "description": "The list of evaluation results that were imported into the app.", "type": "array", "items": { "$ref": "EvaluationResult" } }, "evaluationResultImportFailureCount": { "format": "int32", "description": "The number of evaluation results that either failed to import entirely or completed import with one or more errors.", "type": "integer" }, "evaluationRunImportFailureCount": { "description": "The number of evaluation runs that either failed to import entirely or completed import with one or more errors.", "type": "integer", "format": "int32" } }, "description": "Response message for EvaluationService.ImportEvaluations.", "type": "object", "id": "ImportEvaluationsResponse" }, "ListEvaluationRunsResponse": { "description": "Response message for EvaluationService.ListEvaluationRuns.", "type": "object", "id": "ListEvaluationRunsResponse", "properties": { "evaluationRuns": { "description": "The list of evaluation runs.", "type": "array", "items": { "$ref": "EvaluationRun" } }, "nextPageToken": { "description": "A token that can be sent as ListEvaluationRunsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } } }, "DataStoreTool": { "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", "properties": { "name": { "description": "Required. The data store tool name.", "type": "string" }, "engineSource": { "description": "Optional. Search within an Engine (potentially across multiple DataStores).", "$ref": "DataStoreToolEngineSource" }, "dataStoreSource": { "description": "Optional. Search within a single specific DataStore.", "$ref": "DataStoreToolDataStoreSource" }, "modalityConfigs": { "items": { "$ref": "DataStoreToolModalityConfig" }, "description": "Optional. The modality configs for the data store.", "type": "array" }, "boostSpecs": { "description": "Optional. Boost specification to boost certain documents.", "type": "array", "items": { "$ref": "DataStoreToolBoostSpecs" } }, "description": { "description": "Optional. The tool description.", "type": "string" }, "filterParameterBehavior": { "description": "Optional. The filter parameter behavior.", "type": "string", "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." ], "enum": [ "FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED", "ALWAYS_INCLUDE", "NEVER_INCLUDE" ] } } }, "Guardrail": { "id": "Guardrail", "description": "Guardrail contains a list of checks and balances to keep the agents safe and secure.", "type": "object", "properties": { "modelSafety": { "description": "Optional. Guardrail that blocks the conversation if the LLM response is considered unsafe based on the model safety settings.", "$ref": "GuardrailModelSafety" }, "llmPromptSecurity": { "description": "Optional. Guardrail that blocks the conversation if the prompt is considered unsafe based on the LLM classification.", "$ref": "GuardrailLlmPromptSecurity" }, "llmPolicy": { "description": "Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.", "$ref": "GuardrailLlmPolicy" }, "displayName": { "description": "Required. Display name of the guardrail.", "type": "string" }, "createTime": { "description": "Output only. Timestamp when the guardrail was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when the guardrail was last updated.", "type": "string", "readOnly": true }, "contentFilter": { "description": "Optional. Guardrail that bans certain content from being used in the conversation.", "$ref": "GuardrailContentFilter" }, "name": { "description": "Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "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" }, "description": { "description": "Optional. Description of the guardrail.", "type": "string" }, "action": { "description": "Optional. Action to take when the guardrail is triggered.", "$ref": "TriggerAction" }, "enabled": { "description": "Optional. Whether the guardrail is enabled.", "type": "boolean" }, "codeCallback": { "description": "Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution.", "$ref": "GuardrailCodeCallback" } } }, "TriggerActionGenerativeAnswer": { "id": "TriggerActionGenerativeAnswer", "description": "The agent will immediately respond with a generative answer.", "type": "object", "properties": { "prompt": { "description": "Required. The prompt to use for the generative answer.", "type": "string" } } }, "LanguageSettings": { "properties": { "defaultLanguageCode": { "description": "Optional. The default language code of the app.", "type": "string" }, "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" }, "fallbackAction": { "deprecated": true, "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" } }, "id": "LanguageSettings", "description": "Language settings of the app.", "type": "object" }, "LfA2aV1OAuthFlows": { "description": "Defines the configuration for the supported OAuth 2.0 flows.", "type": "object", "id": "LfA2aV1OAuthFlows", "properties": { "implicit": { "deprecated": true, "description": "Deprecated: Use Authorization Code + PKCE instead.", "$ref": "LfA2aV1ImplicitOAuthFlow" }, "password": { "deprecated": true, "description": "Deprecated: Use Authorization Code + PKCE or Device Code.", "$ref": "LfA2aV1PasswordOAuthFlow" }, "clientCredentials": { "description": "Configuration for the OAuth Client Credentials flow.", "$ref": "LfA2aV1ClientCredentialsOAuthFlow" }, "deviceCode": { "description": "Configuration for the OAuth Device Code flow.", "$ref": "LfA2aV1DeviceCodeOAuthFlow" }, "authorizationCode": { "description": "Configuration for the OAuth Authorization Code flow.", "$ref": "LfA2aV1AuthorizationCodeOAuthFlow" } } }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds": { "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" } }, "description": "Settings for golden evaluations.", "type": "object", "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds" }, "BigQueryExportSettings": { "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" } }, "description": "Settings to describe the BigQuery export behaviors for the app.", "type": "object", "id": "BigQueryExportSettings" }, "Tool": { "description": "A tool represents an action that the CES agent can take to achieve certain goals.", "type": "object", "id": "Tool", "properties": { "pythonFunction": { "description": "Optional. The python function tool.", "$ref": "PythonFunction" }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when the tool was created.", "type": "string", "readOnly": true }, "updateTime": { "description": "Output only. Timestamp when the tool was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "agentTool": { "description": "Optional. The agent tool.", "$ref": "AgentTool" }, "remoteAgentTool": { "description": "Optional. The remote agent tool.", "$ref": "RemoteAgentTool" }, "displayName": { "readOnly": true, "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.", "type": "string" }, "fileSearchTool": { "description": "Optional. The file search tool.", "$ref": "FileSearchTool" }, "toolFakeConfig": { "description": "Optional. Configuration for tool behavior in fake mode.", "$ref": "ToolFakeConfig" }, "widgetTool": { "description": "Optional. The widget tool.", "$ref": "WidgetTool" }, "systemTool": { "description": "Optional. The system tool.", "$ref": "SystemTool" }, "executionType": { "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." ], "description": "Optional. The execution type of the tool.", "type": "string" }, "mcpTool": { "description": "Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.", "$ref": "McpTool" }, "dataStoreTool": { "description": "Optional. The data store tool.", "$ref": "DataStoreTool" }, "connectorTool": { "description": "Optional. The Integration Connector tool.", "$ref": "ConnectorTool" }, "openApiTool": { "description": "Optional. The open API tool.", "$ref": "OpenApiTool" }, "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" }, "googleSearchTool": { "description": "Optional. The google search tool.", "$ref": "GoogleSearchTool" }, "generatedSummary": { "readOnly": true, "description": "Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.", "type": "string" }, "clientFunction": { "description": "Optional. The client function.", "$ref": "ClientFunction" }, "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": { "format": "google-duration", "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" } } }, "SessionOutputDiagnosticInfo": { "properties": { "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" }, "messages": { "description": "List of the messages that happened during the processing.", "type": "array", "items": { "$ref": "Message" } } }, "id": "SessionOutputDiagnosticInfo", "description": "Contains execution details during the processing.", "type": "object" }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds": { "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds", "description": "Expectation level metrics thresholds.", "type": "object", "properties": { "toolInvocationParameterCorrectnessThreshold": { "format": "float", "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" } } }, "DataStoreSettingsEngine": { "properties": { "name": { "readOnly": true, "description": "Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string" }, "type": { "enum": [ "TYPE_UNSPECIFIED", "ENGINE_TYPE_SEARCH", "ENGINE_TYPE_CHAT" ], "readOnly": true, "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.", "type": "string" } }, "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" }, "OpenApiTool": { "properties": { "apiAuthentication": { "description": "Optional. Authentication information required by the API.", "$ref": "ApiAuthentication" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration.", "$ref": "ServiceDirectoryConfig" }, "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" }, "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" }, "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" }, "openApiSchema": { "description": "Required. The OpenAPI schema in JSON or YAML format.", "type": "string" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates that the client will trust.", "$ref": "TlsConfig" } }, "description": "A remote API tool defined by an OpenAPI schema.", "type": "object", "id": "OpenApiTool" }, "ListDeploymentsResponse": { "description": "Response message for AgentService.ListDeployments.", "type": "object", "id": "ListDeploymentsResponse", "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" } } }, "RetrieveToolSchemaRequest": { "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" } }, "description": "Request message for ToolService.RetrieveToolSchema.", "type": "object", "id": "RetrieveToolSchemaRequest" }, "ExportEvaluationsResponse": { "id": "ExportEvaluationsResponse", "description": "Response message for EvaluationService.ExportEvaluations.", "type": "object", "properties": { "evaluationsUri": { "description": "The Google Cloud Storage URI folder where the exported evaluations were written. This will be populated if gcs_uri was specified in the request.", "type": "string" }, "evaluationsContent": { "description": "The content of the exported Evaluations. This will be populated if gcs_uri was not specified in the request.", "type": "string", "format": "byte" }, "failedEvaluations": { "readOnly": true, "description": "Output only. A map of evaluation resource names that could not be exported, to the reason why they failed.", "type": "object", "additionalProperties": { "type": "string" } } } }, "TransferRule": { "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": { "description": "Required. The direction of the transfer.", "type": "string", "enumDescriptions": [ "Unspecified direction.", "Transfer from the parent agent to the child agent.", "Transfer from the child agent to the parent agent." ], "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" } }, "description": "Rule for transferring to a specific agent.", "type": "object", "id": "TransferRule" }, "GenerateAppResourceRequestToolGenerationConfig": { "id": "GenerateAppResourceRequestToolGenerationConfig", "description": "The configuration to be used to generate a tool.", "type": "object", "properties": { "context": { "description": "Optional. The context which describes the tool to be generated. This can be empty if the tool request & response are provided.", "type": "string" }, "openApiToolsetGenerationConfig": { "description": "Optional. The configuration to be used to generate an Open API schema.", "$ref": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig" }, "fileContexts": { "items": { "$ref": "FileContext" }, "description": "Optional. The files to be used as context.", "type": "array" } } }, "AgentTransfer": { "properties": { "displayName": { "readOnly": true, "description": "Output only. Display name of the agent.", "type": "string" }, "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" } }, "description": "Represents an event indicating the transfer of a conversation to a different agent.", "type": "object", "id": "AgentTransfer" }, "EvaluationMetricsConfigScenarioMetricsConfig": { "properties": { "userGoalMetMetricsConfig": { "description": "Optional. Configuration for user goal met metrics.", "$ref": "EvaluationMetricsConfigUserGoalMetMetricsConfig" }, "expectationsMetMetricsConfig": { "description": "Optional. Configuration for expectation level metrics.", "$ref": "EvaluationMetricsConfigExpectationsMetMetricsConfig" } }, "description": "Configuration for the scenario metrics for the evaluation.", "type": "object", "id": "EvaluationMetricsConfigScenarioMetricsConfig" }, "ImportEvaluationsRequestConversationList": { "description": "A list of conversation resource names.", "type": "object", "id": "ImportEvaluationsRequestConversationList", "properties": { "conversations": { "description": "Optional. Conversation resource names.", "type": "array", "items": { "type": "string" } } } }, "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" } } } }, "ChannelProfileWebWidgetConfig": { "description": "Message for configuration for the web widget.", "type": "object", "id": "ChannelProfileWebWidgetConfig", "properties": { "modality": { "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." ], "description": "Optional. The modality of the web widget.", "type": "string", "enum": [ "MODALITY_UNSPECIFIED", "CHAT_AND_VOICE", "VOICE_ONLY", "CHAT_ONLY", "CHAT_VOICE_AND_VIDEO" ] }, "theme": { "enum": [ "THEME_UNSPECIFIED", "LIGHT", "DARK" ], "enumDescriptions": [ "Unknown theme.", "Light theme.", "Dark theme." ], "description": "Optional. The theme of the web widget.", "type": "string" }, "securitySettings": { "description": "Optional. The security settings of the web widget.", "$ref": "ChannelProfileWebWidgetConfigSecuritySettings" }, "webWidgetTitle": { "description": "Optional. The title of the web widget.", "type": "string" } } }, "DataStoreToolModalityConfig": { "description": "If specified, will apply the given configuration for the specified modality.", "type": "object", "id": "DataStoreToolModalityConfig", "properties": { "rewriterConfig": { "description": "Optional. The rewriter config.", "$ref": "DataStoreToolRewriterConfig" }, "groundingConfig": { "description": "Optional. The grounding configuration.", "$ref": "DataStoreToolGroundingConfig" }, "snippetsConfig": { "description": "Optional. The snippets configuration.", "$ref": "DataStoreToolSnippetsConfig" }, "summarizationConfig": { "description": "Optional. The summarization config.", "$ref": "DataStoreToolSummarizationConfig" }, "modalityType": { "enum": [ "MODALITY_TYPE_UNSPECIFIED", "TEXT", "AUDIO" ], "enumDescriptions": [ "Unspecified modality type.", "Text modality.", "Audio modality." ], "description": "Required. The modality type.", "type": "string" } } }, "DataStoreToolSummarizationConfig": { "id": "DataStoreToolSummarizationConfig", "description": "Summarization configuration.", "type": "object", "properties": { "modelSettings": { "description": "Optional. Configurations for the LLM model.", "$ref": "ModelSettings" }, "prompt": { "description": "Optional. The prompt definition. If not set, default prompt will be used.", "type": "string" }, "disabled": { "description": "Optional. Whether summarization is disabled.", "type": "boolean" } } }, "EvaluationScenarioUserFact": { "id": "EvaluationScenarioUserFact", "description": "Facts about the user as a key value pair.", "type": "object", "properties": { "name": { "description": "Required. The name of the user fact.", "type": "string" }, "value": { "description": "Required. The value of the user fact.", "type": "string" } } }, "GenerateAppResourceResponseGenerateResultInfo": { "properties": { "explanation": { "description": "An explanation of the changes in the generated resource.", "type": "string" } }, "description": "This provides additional information about the generated result.", "type": "object", "id": "GenerateAppResourceResponseGenerateResultInfo" }, "BargeInConfig": { "properties": { "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" }, "disableBargeIn": { "deprecated": true, "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" } }, "description": "Configuration for how the user barge-in activities should be handled.", "type": "object", "id": "BargeInConfig" }, "GenerateEvaluationOperationMetadata": { "description": "Operation metadata for EvaluationService.GenerateEvaluation.", "type": "object", "id": "GenerateEvaluationOperationMetadata", "properties": {} }, "ExecuteToolResponse": { "properties": { "toolsetTool": { "description": "The toolset tool that got executed.", "$ref": "ToolsetTool" }, "variables": { "description": "The variable values at the end of the tool execution.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "tool": { "description": "The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "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" }, "citations": { "description": "Citations that provide the source information for the tool's execution.", "$ref": "Citations" }, "googleSearchSuggestions": { "description": "The suggestions returned from Google Search as a result of invoking the Google Search Tool during the tool execution.", "$ref": "GoogleSearchSuggestions" } }, "id": "ExecuteToolResponse", "description": "Response message for ToolService.ExecuteTool.", "type": "object" }, "EvaluationResultTaskCompletionResult": { "description": "The result of the task completion check for the conversation.", "type": "object", "id": "EvaluationResultTaskCompletionResult", "properties": { "score": { "readOnly": true, "description": "Output only. The task completion score. Can be -1, 0, 1", "type": "integer", "format": "int32" }, "explanation": { "description": "Output only. The explanation for the task completion score.", "type": "string", "readOnly": true }, "label": { "description": "Output only. The label associated with each score. Score 1: Task Completed Score 0: Task Not Completed Score -1: User Goal Undefined", "type": "string", "readOnly": true } } }, "LatencyReportToolLatency": { "properties": { "toolDisplayName": { "readOnly": true, "description": "Output only. The display name of the tool.", "type": "string" }, "toolsetTool": { "description": "Output only. The toolset tool identifier.", "$ref": "ToolsetTool", "readOnly": true }, "tool": { "description": "Output only. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.", "type": "string", "readOnly": true }, "latencyMetrics": { "description": "Output only. The latency metrics for the tool.", "$ref": "LatencyReportLatencyMetrics", "readOnly": true } }, "description": "Latency metrics for a single tool.", "type": "object", "id": "LatencyReportToolLatency" }, "GenerateChatTokenRequest": { "description": "Request message for WidgetService.GenerateChatToken.", "type": "object", "id": "GenerateChatTokenRequest", "properties": { "recaptchaToken": { "description": "Optional. The reCAPTCHA token generated by the client-side chat widget.", "type": "string" }, "deployment": { "description": "Required. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}", "type": "string" }, "liveHandoffEnabled": { "description": "Optional. Indicates if live handoff is enabled for the session.", "type": "boolean" } } }, "ToolFakeConfig": { "id": "ToolFakeConfig", "description": "Configuration for tool behavior in fake mode.", "type": "object", "properties": { "codeBlock": { "description": "Optional. Code block which will be executed instead of a real tool call.", "$ref": "CodeBlock" }, "enableFakeMode": { "description": "Optional. Whether the tool is using fake mode.", "type": "boolean" } } }, "ChannelProfile": { "description": "A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony.", "type": "object", "id": "ChannelProfile", "properties": { "disableDtmf": { "description": "Optional. Whether to disable DTMF (dual-tone multi-frequency).", "type": "boolean" }, "profileId": { "description": "Optional. The unique identifier of the channel profile.", "type": "string" }, "whatsappConfig": { "description": "Optional. Configuration specific to WhatsApp deployments.", "$ref": "ChannelProfileWhatsAppConfig" }, "personaProperty": { "description": "Optional. The persona property of the channel profile.", "$ref": "ChannelProfilePersonaProperty" }, "channelType": { "description": "Optional. The type of the channel profile.", "type": "string", "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." ], "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" ] }, "webWidgetConfig": { "description": "Optional. The configuration for the web widget.", "$ref": "ChannelProfileWebWidgetConfig" }, "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" }, "noiseSuppressionLevel": { "description": "Optional. The noise suppression level of the channel profile. Available values are \"low\", \"moderate\", \"high\", \"very_high\".", "type": "string" }, "instagramConfig": { "description": "Optional. Configuration specific to Instagram deployments.", "$ref": "ChannelProfileInstagramConfig" } } }, "AggregatedMetricsSemanticSimilarityMetrics": { "id": "AggregatedMetricsSemanticSimilarityMetrics", "description": "Metrics for semantic similarity results.", "type": "object", "properties": { "score": { "readOnly": true, "description": "Output only. The average semantic similarity score (0-4).", "type": "number", "format": "float" } } }, "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" } }, "description": "Defines a security scheme using OpenID Connect.", "type": "object", "id": "LfA2aV1OpenIdConnectSecurityScheme" }, "RetrieveToolsResponse": { "id": "RetrieveToolsResponse", "description": "Response message for ToolService.RetrieveTools.", "type": "object", "properties": { "tools": { "items": { "$ref": "Tool" }, "description": "The list of tools that are included in the specified toolset.", "type": "array" } } }, "GuardrailContentFilter": { "properties": { "bannedContentsInUserInput": { "description": "Optional. List of banned phrases. Applies only to user inputs.", "type": "array", "items": { "type": "string" } }, "disregardDiacritics": { "description": "Optional. If true, diacritics are ignored during matching.", "type": "boolean" }, "bannedContentsInAgentResponse": { "items": { "type": "string" }, "description": "Optional. List of banned phrases. Applies only to agent responses.", "type": "array" }, "bannedContents": { "description": "Optional. List of banned phrases. Applies to both user inputs and agent responses.", "type": "array", "items": { "type": "string" } }, "matchType": { "description": "Required. Match type for the content filter.", "type": "string", "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." ], "enum": [ "MATCH_TYPE_UNSPECIFIED", "SIMPLE_STRING_MATCH", "WORD_BOUNDARY_STRING_MATCH", "REGEXP_MATCH" ] } }, "description": "Guardrail that bans certain content from being used in the conversation.", "type": "object", "id": "GuardrailContentFilter" }, "ServiceAgentIdTokenAuthConfig": { "description": "Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent.", "type": "object", "id": "ServiceAgentIdTokenAuthConfig", "properties": {} }, "GoogleSearchToolPromptConfig": { "id": "GoogleSearchToolPromptConfig", "description": "Prompt settings used by the model when processing or summarizing the google search results.", "type": "object", "properties": { "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" }, "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" } } }, "GuardrailLlmPromptSecurity": { "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" }, "customPolicy": { "description": "Optional. Use a user-defined LlmPolicy to configure the security guardrail.", "$ref": "GuardrailLlmPolicy" }, "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" } }, "description": "Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification.", "type": "object", "id": "GuardrailLlmPromptSecurity" }, "EvaluationResultScenarioExpectationOutcomeObservedToolCall": { "description": "The observed tool call and response.", "type": "object", "id": "EvaluationResultScenarioExpectationOutcomeObservedToolCall", "properties": { "toolCall": { "description": "Output only. The observed tool call.", "$ref": "ToolCall", "readOnly": true }, "toolResponse": { "readOnly": true, "description": "Output only. The observed tool response.", "$ref": "ToolResponse" } } }, "InstagramCredentials": { "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" } }, "description": "Ephemeral Meta credentials for Instagram native integration.", "type": "object", "id": "InstagramCredentials" }, "ChannelProfileInstagramConfig": { "properties": { "instagramAccountId": { "description": "Required. The Instagram Account ID.", "type": "string" }, "displayName": { "description": "Output only. The fetched Meta business page name.", "type": "string", "readOnly": true }, "thumbnailUrl": { "description": "Output only. The fetched Meta business profile thumbnail URL.", "type": "string", "readOnly": true }, "description": { "description": "Output only. The description of the Meta business page or profile.", "type": "string", "readOnly": true } }, "description": "Configuration specific to Instagram deployments.", "type": "object", "id": "ChannelProfileInstagramConfig" }, "Schema": { "description": "Represents a select subset of an OpenAPI 3.0 schema object.", "type": "object", "id": "Schema", "properties": { "uniqueItems": { "description": "Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.", "type": "boolean" }, "minimum": { "format": "double", "description": "Optional. Minimum value for Type.INTEGER and Type.NUMBER.", "type": "number" }, "default": { "description": "Optional. Default value of the data.", "type": "any" }, "anyOf": { "items": { "$ref": "Schema" }, "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", "type": "array" }, "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" }, "minItems": { "format": "int64", "description": "Optional. Minimum number of the elements for Type.ARRAY.", "type": "string" }, "properties": { "additionalProperties": { "$ref": "Schema" }, "description": "Optional. Properties of Type.OBJECT.", "type": "object" }, "enum": { "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", "items": { "type": "string" } }, "nullable": { "description": "Optional. Indicates if the value may be null.", "type": "boolean" }, "defs": { "description": "Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.", "type": "object", "additionalProperties": { "$ref": "Schema" } }, "maximum": { "description": "Optional. Maximum value for Type.INTEGER and Type.NUMBER.", "type": "number", "format": "double" }, "type": { "enum": [ "TYPE_UNSPECIFIED", "STRING", "INTEGER", "NUMBER", "BOOLEAN", "OBJECT", "ARRAY" ], "enumDescriptions": [ "Type unspecified.", "String type.", "Integer type.", "Number type.", "Boolean type.", "Object type.", "Array type." ], "description": "Required. The type of the data.", "type": "string" }, "description": { "description": "Optional. The description of the data.", "type": "string" }, "items": { "description": "Optional. Schema of the elements of Type.ARRAY.", "$ref": "Schema" }, "required": { "description": "Optional. Required properties of Type.OBJECT.", "type": "array", "items": { "type": "string" } }, "maxItems": { "description": "Optional. Maximum number of the elements for Type.ARRAY.", "type": "string", "format": "int64" }, "additionalProperties": { "description": "Optional. Can either be a boolean or an object, controls the presence of additional properties.", "$ref": "Schema" }, "title": { "description": "Optional. The title of the schema.", "type": "string" } } }, "DataStoreConnectorConfig": { "id": "DataStoreConnectorConfig", "description": "The connector config for the data store connection.", "type": "object", "properties": { "dataSource": { "description": "The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.", "type": "string" }, "collection": { "description": "Resource name of the collection the data store belongs to.", "type": "string" }, "collectionDisplayName": { "description": "Display name of the collection the data store belongs to.", "type": "string" } } }, "ListAgentsResponse": { "description": "Response message for AgentService.ListAgents.", "type": "object", "id": "ListAgentsResponse", "properties": { "agents": { "description": "The list of agents.", "type": "array", "items": { "$ref": "Agent" } }, "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" } } }, "Action": { "properties": { "entityOperation": { "description": "Entity operation configuration for the tool to use.", "$ref": "ActionEntityOperation" }, "outputFields": { "description": "Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.", "type": "array", "items": { "type": "string" } }, "connectionActionId": { "description": "ID of a Connection action for the tool to use.", "type": "string" }, "inputFields": { "items": { "type": "string" }, "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" } }, "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" }, "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" } } }, "ClientCertificateSettings": { "id": "ClientCertificateSettings", "description": "Settings for custom client certificates.", "type": "object", "properties": { "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" }, "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" } } }, "AggregatedMetricsToolMetrics": { "description": "Metrics for a single tool.", "type": "object", "id": "AggregatedMetricsToolMetrics", "properties": { "tool": { "readOnly": true, "description": "Output only. The name of the tool.", "type": "string" }, "passCount": { "readOnly": true, "description": "Output only. The number of times the tool passed.", "type": "integer", "format": "int32" }, "failCount": { "format": "int32", "description": "Output only. The number of times the tool failed.", "type": "integer", "readOnly": true } } }, "ListEvaluationsResponse": { "description": "Response message for EvaluationService.ListEvaluations.", "type": "object", "id": "ListEvaluationsResponse", "properties": { "nextPageToken": { "description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" }, "evaluations": { "items": { "$ref": "Evaluation" }, "description": "The list of evaluations.", "type": "array" } } }, "Toolset": { "id": "Toolset", "description": "A toolset represents a group of dynamically managed tools that can be used by the agent.", "type": "object", "properties": { "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" }, "connectorToolset": { "description": "Optional. A toolset that generates tools from an Integration Connectors Connection.", "$ref": "ConnectorToolset" }, "executionType": { "description": "Optional. The execution type of the tools in the toolset.", "type": "string", "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." ], "enum": [ "EXECUTION_TYPE_UNSPECIFIED", "SYNCHRONOUS", "ASYNCHRONOUS" ] }, "openApiToolset": { "description": "Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema.", "$ref": "OpenApiToolset" }, "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" }, "toolFakeConfig": { "description": "Optional. Configuration for tools behavior in fake mode.", "$ref": "ToolFakeConfig" }, "displayName": { "description": "Optional. The display name of the toolset. Must be unique within the same app.", "type": "string" }, "mcpToolset": { "description": "Optional. A toolset that contains a list of tools that are offered by the MCP server.", "$ref": "McpToolset" }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when the toolset was created.", "type": "string", "readOnly": true }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when the toolset was last updated.", "type": "string", "readOnly": true } } }, "EvaluationScenario": { "description": "The config for a scenario", "type": "object", "id": "EvaluationScenario", "properties": { "evaluationExpectations": { "description": "Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}`", "type": "array", "items": { "type": "string" } }, "scenarioExpectations": { "items": { "$ref": "EvaluationScenarioExpectation" }, "description": "Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation.", "type": "array" }, "maxTurns": { "description": "Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100.", "type": "integer", "format": "int32" }, "userGoalBehavior": { "enumDescriptions": [ "Behavior unspecified. Will default to USER_GOAL_SATISFIED.", "The user goal should be completed successfully.", "The user goal should be rejected.", "Ignore the user goal status." ], "description": "Optional. The expected behavior of the user goal.", "type": "string", "enum": [ "USER_GOAL_BEHAVIOR_UNSPECIFIED", "USER_GOAL_SATISFIED", "USER_GOAL_REJECTED", "USER_GOAL_IGNORED" ] }, "taskCompletionBehavior": { "enumDescriptions": [ "Behavior unspecified. Will default to TASK_SATISFIED.", "The user task should be completed successfully.", "The user task should be rejected." ], "description": "Optional. Deprecated. Use user_goal_behavior instead.", "type": "string", "deprecated": true, "enum": [ "TASK_COMPLETION_BEHAVIOR_UNSPECIFIED", "TASK_SATISFIED", "TASK_REJECTED" ] }, "variableOverrides": { "description": "Optional. Variables / Session Parameters as context for the session, keyed by variable names. Members of this struct will override any default values set by the system. Note, these are different from user facts, which are facts known to the user. Variables are parameters known to the agent: i.e. MDN (phone number) passed by the telephony system.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "scenarioExecutionMode": { "description": "Optional. The execution mode for scenario evaluations.", "type": "string", "enumDescriptions": [ "Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.", "Quality optimized mode.", "Speed optimized mode." ], "enum": [ "SCENARIO_EXECUTION_MODE_UNSPECIFIED", "QUALITY_OPTIMIZED", "SPEED_OPTIMIZED" ] }, "rubrics": { "description": "Required. The rubrics to score the scenario against.", "type": "array", "items": { "type": "string" } }, "userFacts": { "items": { "$ref": "EvaluationScenarioUserFact" }, "description": "Optional. The user facts to be used by the scenario.", "type": "array" }, "task": { "description": "Required. The task to be targeted by the scenario.", "type": "string" } } }, "TriggerActionResponse": { "properties": { "disabled": { "description": "Optional. Whether the response is disabled. Disabled responses are not used by the agent.", "type": "boolean" }, "text": { "description": "Required. Text for the agent to respond with.", "type": "string" } }, "id": "TriggerActionResponse", "description": "Represents a response from the agent.", "type": "object" }, "EndUserAuthConfig": { "properties": { "oauth2AuthCodeConfig": { "description": "Oauth 2.0 Authorization Code authentication.", "$ref": "EndUserAuthConfigOauth2AuthCodeConfig" }, "oauth2JwtBearerConfig": { "description": "JWT Profile Oauth 2.0 Authorization Grant authentication.", "$ref": "EndUserAuthConfigOauth2JwtBearerConfig" } }, "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", "id": "EndUserAuthConfig" }, "EvaluationMetricsConfigHallucinationMetricsConfig": { "properties": { "enableHallucinationMetrics": { "description": "Optional. Whether to calculate hallucination metrics for the evaluation.", "type": "boolean" } }, "id": "EvaluationMetricsConfigHallucinationMetricsConfig", "description": "Configuration for the hallucination metrics for the evaluation. To disable the metric, set the message but do not set the `enable_hallucination_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", "type": "object" }, "LfA2aV1AgentExtension": { "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" }, "params": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Extension-specific configuration parameters.", "type": "object" }, "required": { "description": "If true, the client must understand and comply with the extension's requirements.", "type": "boolean" } }, "id": "LfA2aV1AgentExtension", "description": "A declaration of a protocol extension supported by an Agent.", "type": "object" }, "DataStoreToolSnippetsConfig": { "id": "DataStoreToolSnippetsConfig", "description": "Snippets configuration.", "type": "object", "properties": { "enableSnippets": { "description": "Optional. Whether snippets are enabled.", "type": "boolean" } } }, "FileContext": { "properties": { "fileBytes": { "description": "Optional. File provided as raw bytes.", "$ref": "FileContextFileBytes" } }, "description": "Files to be used as context. Files can be provided as raw bytes.", "type": "object", "id": "FileContext" }, "TestPersonaVoiceRequest": { "description": "Request message for EvaluationService.TestPersonaVoice.", "type": "object", "id": "TestPersonaVoiceRequest", "properties": { "personaId": { "description": "Required. The persona ID to test the voice for. Also accepts \"default\".", "type": "string" }, "text": { "description": "Required. The text to test the voice for.", "type": "string" } } }, "GenerateChatTokenResponse": { "properties": { "chatToken": { "description": "The session scoped token for chat widget to authenticate with Session APIs.", "type": "string" }, "expireTime": { "format": "google-datetime", "description": "The time at which the chat token expires.", "type": "string" } }, "id": "GenerateChatTokenResponse", "description": "Response message for WidgetService.GenerateChatToken.", "type": "object" }, "LatencyReport": { "description": "Latency report for the evaluation run.", "type": "object", "id": "LatencyReport", "properties": { "toolLatencies": { "readOnly": true, "description": "Output only. Unordered list. Latency metrics for each tool.", "type": "array", "items": { "$ref": "LatencyReportToolLatency" } }, "guardrailLatencies": { "description": "Output only. Unordered list. Latency metrics for each guardrail.", "type": "array", "readOnly": true, "items": { "$ref": "LatencyReportGuardrailLatency" } }, "llmCallLatencies": { "description": "Output only. Unordered list. Latency metrics for each LLM call.", "type": "array", "readOnly": true, "items": { "$ref": "LatencyReportLlmCallLatency" } }, "sessionCount": { "readOnly": true, "description": "Output only. The total number of sessions considered in the latency report.", "type": "integer", "format": "int32" }, "callbackLatencies": { "items": { "$ref": "LatencyReportCallbackLatency" }, "readOnly": true, "description": "Output only. Unordered list. Latency metrics for each callback.", "type": "array" } } }, "AggregatedMetricsTurnLatencyMetrics": { "properties": { "averageLatency": { "format": "google-duration", "description": "Output only. The average latency of the turns.", "type": "string", "readOnly": true } }, "description": "Metrics for turn latency.", "type": "object", "id": "AggregatedMetricsTurnLatencyMetrics" }, "ToolCall": { "properties": { "displayName": { "description": "Output only. Display name of the tool.", "type": "string", "readOnly": true }, "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" }, "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" }, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" } }, "description": "Request for the client or the agent to execute the specified tool.", "type": "object", "id": "ToolCall" }, "PythonCodeCondition": { "properties": { "pythonCode": { "description": "Required. The python code to execute.", "type": "string" } }, "id": "PythonCodeCondition", "description": "Python code block to evaluate the condition.", "type": "object" }, "ListChangelogsResponse": { "properties": { "changelogs": { "items": { "$ref": "Changelog" }, "description": "The list of changelogs.", "type": "array" }, "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" } }, "description": "Response message for AgentService.ListChangelogs.", "type": "object", "id": "ListChangelogsResponse" }, "BatchDeleteConversationsRequest": { "description": "Request message for AgentService.BatchDeleteConversations.", "type": "object", "id": "BatchDeleteConversationsRequest", "properties": { "conversations": { "description": "Required. The resource names of the conversations to delete.", "type": "array", "items": { "type": "string" } } } }, "DataStoreToolDataStoreSource": { "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" } }, "description": "Configuration for searching within a specific DataStore.", "type": "object", "id": "DataStoreToolDataStoreSource" }, "FileContextFileBytes": { "id": "FileContextFileBytes", "description": "File provided as raw bytes.", "type": "object", "properties": { "data": { "description": "Required. Raw bytes of the file.", "type": "string", "format": "byte" }, "fileName": { "description": "Required. The name of the file provided as raw bytes.", "type": "string" }, "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" } } }, "ErrorHandlingSettingsFallbackResponseConfig": { "properties": { "maxFallbackAttempts": { "format": "int32", "description": "Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.", "type": "integer" }, "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" }, "GoogleSearchSuggestions": { "description": "Search suggestions from Google Search Tool.", "type": "object", "id": "GoogleSearchSuggestions", "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": { "description": "List of queries used to perform the google search along with the search result URIs forming the search suggestions.", "type": "array", "items": { "$ref": "WebSearchQuery" } } } }, "ListEvaluationDatasetsResponse": { "description": "Response message for EvaluationService.ListEvaluationDatasets.", "type": "object", "id": "ListEvaluationDatasetsResponse", "properties": { "evaluationDatasets": { "items": { "$ref": "EvaluationDataset" }, "description": "The list of evaluation datasets.", "type": "array" }, "nextPageToken": { "description": "A token that can be sent as ListEvaluationDatasetsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } } }, "EvaluationRunCachingSettings": { "properties": { "runCachingMode": { "description": "Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN.", "type": "string", "enumDescriptions": [ "The run caching mode is unspecified.", "Always execute a full live simulation regardless of whether changelogs exist.", "Skip execution and copy previous verified results if no dependencies have mutated, the evaluation channel/run method are the same." ], "enum": [ "EVALUATION_RUN_CACHING_MODE_UNSPECIFIED", "FORCE_RUN", "SKIP_IF_UNCHANGED" ] } }, "description": "Settings for evaluation run caching.", "type": "object", "id": "EvaluationRunCachingSettings" }, "ListToolsResponse": { "description": "Response message for AgentService.ListTools.", "type": "object", "id": "ListToolsResponse", "properties": { "tools": { "description": "The list of tools.", "type": "array", "items": { "$ref": "Tool" } }, "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" } } }, "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", "id": "Deployment", "properties": { "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" ] }, "createTime": { "readOnly": true, "description": "Output only. Timestamp when this deployment was created.", "type": "string", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when this deployment was last updated.", "type": "string", "readOnly": true }, "displayName": { "description": "Required. Display name of the deployment.", "type": "string" }, "channelProfile": { "description": "Required. The channel profile used in the deployment.", "$ref": "ChannelProfile" }, "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" }, "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" }, "etag": { "readOnly": true, "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.", "type": "string" }, "whatsappCredentials": { "description": "Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile.", "$ref": "WhatsAppCredentials" }, "instagramCredentials": { "description": "Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile.", "$ref": "InstagramCredentials" }, "name": { "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" }, "experimentConfig": { "description": "Optional. Experiment configuration for the deployment.", "$ref": "ExperimentConfig" } } }, "LfA2aV1StringList": { "id": "LfA2aV1StringList", "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.", "type": "object", "properties": { "list": { "items": { "type": "string" }, "description": "The individual string values.", "type": "array" } } }, "OpenApiToolset": { "description": "A toolset that contains a list of tools that are defined by an OpenAPI schema.", "type": "object", "id": "OpenApiToolset", "properties": { "apiAuthentication": { "description": "Optional. Authentication information required by the API.", "$ref": "ApiAuthentication" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration.", "$ref": "ServiceDirectoryConfig" }, "openApiSchema": { "description": "Required. The OpenAPI schema of the toolset.", "type": "string" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates", "$ref": "TlsConfig" }, "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" } } }, "McpToolDefinition": { "properties": { "outputSchema": { "readOnly": true, "description": "Output only. The schema of the output arguments of the MCP tool.", "$ref": "Schema" }, "inputSchema": { "readOnly": true, "description": "Output only. The schema of the input arguments of the MCP tool.", "$ref": "Schema" }, "description": { "readOnly": true, "description": "Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`.", "type": "string" } }, "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", "id": "McpToolDefinition" }, "Citations": { "properties": { "citedChunks": { "description": "List of cited pieces of information.", "type": "array", "items": { "$ref": "CitationsCitedChunk" } } }, "id": "Citations", "description": "Citations associated with the agent response.", "type": "object" }, "EvaluationDataset": { "properties": { "displayName": { "description": "Required. User-defined display name of the evaluation dataset. Unique within an App.", "type": "string" }, "createdBy": { "description": "Output only. The user who created the evaluation dataset.", "type": "string", "readOnly": true }, "lastUpdatedBy": { "description": "Output only. The user who last updated the evaluation dataset.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. Timestamp when the evaluation dataset was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when the evaluation dataset was last updated.", "type": "string", "readOnly": true }, "name": { "description": "Identifier. The unique identifier of this evaluation dataset. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "type": "string" }, "aggregatedMetrics": { "description": "Output only. The aggregated metrics for this evaluation dataset across all runs.", "$ref": "AggregatedMetrics", "readOnly": true }, "evaluations": { "items": { "type": "string" }, "description": "Optional. Evaluations that are included in this dataset.", "type": "array" }, "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.", "type": "string", "readOnly": true } }, "id": "EvaluationDataset", "description": "An evaluation dataset represents a set of evaluations that are grouped together basaed on shared tags.", "type": "object" }, "SessionConfigRemoteDialogflowQueryParameters": { "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", "properties": { "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" } }, "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": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "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" } } }, "ExportOptions": { "properties": { "exportFormat": { "description": "Optional. The format to export the evaluation results in. Defaults to JSON if not specified.", "type": "string", "enumDescriptions": [ "Unspecified format.", "JSON format.", "YAML format." ], "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "JSON", "YAML" ] }, "gcsUri": { "description": "Optional. The Google Cloud Storage URI to write the exported Evaluation Results to.", "type": "string" } }, "id": "ExportOptions", "description": "Options for exporting CES evaluation resources.", "type": "object" }, "LfA2aV1HTTPAuthSecurityScheme": { "properties": { "description": { "description": "An optional description for the security scheme.", "type": "string" }, "bearerFormat": { "description": "A hint to the client to identify how the bearer token is formatted (e.g., \"JWT\"). Primarily for documentation purposes.", "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" }, "RetrieveToolsRequest": { "description": "Request message for ToolService.RetrieveTools.", "type": "object", "id": "RetrieveToolsRequest", "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" } } }, "TestPersonaVoiceResponse": { "id": "TestPersonaVoiceResponse", "description": "Response message for EvaluationService.TestPersonaVoice.", "type": "object", "properties": { "audio": { "description": "The audio data bytes of the synthesized voice.", "type": "string", "format": "byte" } } }, "SessionConfig": { "id": "SessionConfig", "description": "The configuration for the session.", "type": "object", "properties": { "deployment": { "description": "Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" }, "excludeDiagnosticInfo": { "description": "Optional. Whether to exclude diagnostic info from the session output.", "type": "boolean" }, "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" }, "inputAudioConfig": { "description": "Optional. Configuration for processing the input audio.", "$ref": "InputAudioConfig" }, "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" }, "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" }, "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" }, "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" }, "historicalContexts": { "items": { "$ref": "Message" }, "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" } } }, "ApiKeyConfig": { "id": "ApiKeyConfig", "description": "Configurations for authentication with API key.", "type": "object", "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" }, "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" }, "requestLocation": { "description": "Required. Key location in the request.", "type": "string", "enumDescriptions": [ "Unspecified. This value should not be used.", "Represents the key in http header.", "Represents the key in query string." ], "enum": [ "REQUEST_LOCATION_UNSPECIFIED", "HEADER", "QUERY_STRING" ] } } }, "GuardrailModelSafetySafetySetting": { "id": "GuardrailModelSafetySafetySetting", "description": "Safety setting.", "type": "object", "properties": { "category": { "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT" ], "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" }, "threshold": { "description": "Required. The harm block threshold.", "type": "string", "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." ], "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", "BLOCK_NONE", "OFF" ] } } }, "ConversationLoggingSettings": { "description": "Settings to describe the conversation logging behaviors for the app.", "type": "object", "id": "ConversationLoggingSettings", "properties": { "retentionWindow": { "format": "google-duration", "description": "Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days.", "type": "string" }, "disableConversationLogging": { "description": "Optional. Whether to disable conversation logging for the sessions.", "type": "boolean" } } }, "EvaluationResultScenarioRubricOutcome": { "id": "EvaluationResultScenarioRubricOutcome", "description": "The outcome of the evaluation against the rubric.", "type": "object", "properties": { "rubric": { "description": "Output only. The rubric that was used to evaluate the conversation.", "type": "string", "readOnly": true }, "score": { "description": "Output only. The score of the conversation against the rubric.", "type": "number", "readOnly": true, "format": "float" }, "scoreExplanation": { "readOnly": true, "description": "Output only. The rater's response to the rubric.", "type": "string" } } }, "ListToolsetsResponse": { "id": "ListToolsetsResponse", "description": "Response message for AgentService.ListToolsets.", "type": "object", "properties": { "toolsets": { "description": "The list of toolsets.", "type": "array", "items": { "$ref": "Toolset" } }, "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" } } }, "Span": { "description": "A span is a unit of work or a single operation during the request processing.", "type": "object", "id": "Span", "properties": { "duration": { "format": "google-duration", "description": "Output only. The duration of the span.", "type": "string", "readOnly": true }, "childSpans": { "items": { "$ref": "Span" }, "readOnly": true, "description": "Output only. The child spans that are nested under this span.", "type": "array" }, "name": { "description": "Output only. The name of the span.", "type": "string", "readOnly": true }, "endTime": { "format": "google-datetime", "description": "Output only. The end time of the span.", "type": "string", "readOnly": true }, "startTime": { "format": "google-datetime", "description": "Output only. The start time of the span.", "type": "string", "readOnly": true }, "attributes": { "readOnly": true, "description": "Output only. Key-value attributes associated with the span.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "ListExamplesResponse": { "properties": { "examples": { "items": { "$ref": "Example" }, "description": "The list of examples.", "type": "array" }, "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" } }, "description": "Response message for AgentService.ListExamples.", "type": "object", "id": "ListExamplesResponse" }, "ScheduledEvaluationRunSchedulingConfig": { "description": "Eval scheduling configuration details", "type": "object", "id": "ScheduledEvaluationRunSchedulingConfig", "properties": { "frequency": { "enum": [ "FREQUENCY_UNSPECIFIED", "NONE", "DAILY", "WEEKLY", "BIWEEKLY" ], "description": "Required. The frequency with which to run the eval", "type": "string", "enumDescriptions": [ "The frequency is unspecified.", "Indicates a one-time scheduled run that should not repeat", "Run the evaluation daily.", "Run the evaluation weekly.", "Run the evaluation biweekly." ] }, "startTime": { "description": "Required. Timestamp when the eval should start.", "type": "string", "format": "google-datetime" }, "daysOfWeek": { "items": { "format": "int32", "type": "integer" }, "description": "Optional. The days of the week to run the eval. Applicable only for Weekly and Biweekly frequencies. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday.", "type": "array" } } }, "ScheduledEvaluationRun": { "properties": { "request": { "description": "Required. The RunEvaluationRequest to schedule", "$ref": "RunEvaluationRequest" }, "displayName": { "description": "Required. User-defined display name of the scheduled evaluation run config.", "type": "string" }, "createdBy": { "description": "Output only. The user who created the scheduled evaluation run.", "type": "string", "readOnly": true }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the scheduled evaluation run was created.", "type": "string" }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the evaluation was last updated.", "type": "string" }, "totalExecutions": { "readOnly": true, "description": "Output only. The total number of times this run has been executed", "type": "integer", "format": "int32" }, "lastUpdatedBy": { "description": "Output only. The user who last updated the evaluation.", "type": "string", "readOnly": true }, "name": { "description": "Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}", "type": "string" }, "active": { "description": "Optional. Whether this config is active", "type": "boolean" }, "schedulingConfig": { "description": "Required. Configuration for the timing and frequency with which to execute the evaluations.", "$ref": "ScheduledEvaluationRunSchedulingConfig" }, "etag": { "readOnly": true, "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.", "type": "string" }, "description": { "description": "Optional. User-defined description of the scheduled evaluation run.", "type": "string" }, "lastCompletedRun": { "readOnly": true, "description": "Output only. The last successful EvaluationRun of this scheduled execution. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`", "type": "string" }, "nextScheduledExecutionTime": { "format": "google-datetime", "description": "Output only. The next time this is scheduled to execute", "type": "string", "readOnly": true } }, "id": "ScheduledEvaluationRun", "description": "Represents a scheduled evaluation run configuration.", "type": "object" }, "ListConversationsResponse": { "description": "Response message for AgentService.ListConversations.", "type": "object", "id": "ListConversationsResponse", "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" } } }, "ConversationTurn": { "id": "ConversationTurn", "description": "All information about a single turn in the conversation.", "type": "object", "properties": { "rootSpan": { "description": "Optional. The root span of the action processing.", "$ref": "Span" }, "messages": { "description": "Optional. List of messages in the conversation turn, including user input, agent responses and intermediate events during the processing.", "type": "array", "items": { "$ref": "Message" } }, "userIntendedText": { "description": "Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled.", "type": "string" } } }, "WidgetTool": { "properties": { "description": { "description": "Optional. The description of the widget tool.", "type": "string" }, "uiConfig": { "description": "Optional. Configuration for rendering the widget.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "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" }, "widgetType": { "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" ], "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" }, "name": { "description": "Required. The display name of the widget tool.", "type": "string" }, "textResponseConfig": { "description": "Optional. Configuration for always-included text responses.", "$ref": "WidgetToolTextResponseConfig" } }, "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", "id": "WidgetTool" }, "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" } } }, "Callback": { "id": "Callback", "description": "A callback defines the custom logic to be executed at various stages of agent interaction.", "type": "object", "properties": { "disabled": { "description": "Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.", "type": "boolean" }, "pythonCode": { "description": "Required. The python code to execute for the callback.", "type": "string" }, "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" } } }, "GuardrailLlmPromptSecurityDefaultSecuritySettings": { "id": "GuardrailLlmPromptSecurityDefaultSecuritySettings", "description": "Configuration for default system security settings.", "type": "object", "properties": { "defaultPromptTemplate": { "readOnly": true, "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.", "type": "string" } } }, "App": { "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", "properties": { "evaluationMetricsThresholds": { "description": "Optional. The evaluation thresholds for the app.", "$ref": "EvaluationMetricsThresholds" }, "toolExecutionMode": { "enum": [ "TOOL_EXECUTION_MODE_UNSPECIFIED", "PARALLEL", "SEQUENTIAL" ], "description": "Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.", "type": "string", "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." ] }, "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" }, "displayName": { "description": "Required. Display name of the app.", "type": "string" }, "clientCertificateSettings": { "description": "Optional. The default client certificate settings for the app.", "$ref": "ClientCertificateSettings" }, "errorHandlingSettings": { "description": "Optional. Error handling settings of the app.", "$ref": "ErrorHandlingSettings" }, "validationErrors": { "readOnly": true, "description": "Output only. Misconfigurations or warnings in the app.", "type": "array", "items": { "type": "string" } }, "predefinedVariableDeclarations": { "readOnly": true, "description": "Output only. The declarations of predefined variables for the app.", "type": "array", "items": { "$ref": "AppVariableDeclaration" } }, "etag": { "readOnly": true, "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.", "type": "string" }, "vpcScSettings": { "description": "Optional. VPC-SC settings for the app.", "$ref": "VpcScSettings" }, "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" }, "audioProcessingConfig": { "description": "Optional. Audio processing configuration of the app.", "$ref": "AudioProcessingConfig" }, "evaluationPersonas": { "description": "Optional. The evaluation personas for the app. This field is used to define the personas that can be used for evaluation. Maximum of 30 personas can be defined.", "type": "array", "items": { "$ref": "EvaluationPersona" } }, "deploymentCount": { "readOnly": true, "description": "Output only. Number of deployments in the app.", "type": "integer", "format": "int32" }, "evaluationSettings": { "description": "Optional. The evaluation settings for the app.", "$ref": "EvaluationSettings" }, "timeZoneSettings": { "description": "Optional. TimeZone settings of the app.", "$ref": "TimeZoneSettings" }, "rootAgent": { "description": "Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "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" }, "guardrails": { "description": "Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "type": "array", "items": { "type": "string" } }, "createTime": { "description": "Output only. Timestamp when the app was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the app was last updated.", "type": "string" }, "defaultChannelProfile": { "description": "Optional. The default channel profile used by the app.", "$ref": "ChannelProfile" }, "description": { "description": "Optional. Human-readable description of the app.", "type": "string" }, "languageSettings": { "description": "Optional. Language settings of the app.", "$ref": "LanguageSettings" }, "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" }, "variableDeclarations": { "items": { "$ref": "AppVariableDeclaration" }, "description": "Optional. The declarations of the variables.", "type": "array" }, "name": { "description": "Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string" }, "pinned": { "description": "Optional. Whether the app is pinned in the app list.", "type": "boolean" }, "loggingSettings": { "description": "Optional. Logging settings of the app.", "$ref": "LoggingSettings" }, "dataStoreSettings": { "description": "Optional. The data store settings for the app.", "$ref": "DataStoreSettings" } } }, "InputAudioConfig": { "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 input audio data.", "type": "string", "enum": [ "AUDIO_ENCODING_UNSPECIFIED", "LINEAR16", "MULAW", "ALAW" ] }, "sampleRateHertz": { "format": "int32", "description": "Required. The sample rate (in Hertz) of the input audio data.", "type": "integer" }, "noiseSuppressionLevel": { "description": "Optional. Whether to enable noise suppression on the input audio. Available values are \"low\", \"moderate\", \"high\", \"very_high\".", "type": "string" } }, "description": "InputAudioConfig configures how the CES agent should interpret the incoming audio data.", "type": "object", "id": "InputAudioConfig" }, "BearerTokenConfig": { "properties": { "token": { "description": "Required. The bearer token. Must be in the format `$context.variables.`.", "type": "string" } }, "description": "Configurations for authentication with a bearer token.", "type": "object", "id": "BearerTokenConfig" }, "TlsConfig": { "properties": { "caCerts": { "items": { "$ref": "TlsConfigCaCert" }, "description": "Required. Specifies a list of allowed custom CA certificates for HTTPS verification.", "type": "array" } }, "id": "TlsConfig", "description": "The TLS configuration.", "type": "object" }, "AggregatedMetrics": { "description": "Aggregated metrics for an evaluation or evaluation dataset.", "type": "object", "id": "AggregatedMetrics", "properties": { "metricsByAppVersion": { "description": "Output only. Aggregated metrics, grouped by app version ID.", "type": "array", "readOnly": true, "items": { "$ref": "AggregatedMetricsMetricsByAppVersion" } } } }, "EvaluationPersona": { "properties": { "description": { "description": "Optional. The description of the persona.", "type": "string" }, "displayName": { "description": "Required. The display name of the persona. Unique within an app.", "type": "string" }, "personality": { "description": "Required. An instruction for the agent on how to behave in the evaluation.", "type": "string" }, "name": { "description": "Required. The unique identifier of the persona. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`", "type": "string" }, "speechConfig": { "description": "Optional. Configuration for how the persona sounds (TTS settings).", "$ref": "EvaluationPersonaSpeechConfig" } }, "id": "EvaluationPersona", "description": "A persona represents an end user in an evaluation.", "type": "object" }, "LfA2aV1AuthenticationInfo": { "properties": { "credentials": { "description": "Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).", "type": "string" }, "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" } }, "id": "LfA2aV1AuthenticationInfo", "description": "Defines authentication details, used for push notifications.", "type": "object" }, "EvaluationRun": { "description": "An evaluation run represents an all the evaluation results from an evaluation execution.", "type": "object", "id": "EvaluationRun", "properties": { "errorInfo": { "readOnly": true, "description": "Output only. Error information for the evaluation run.", "$ref": "EvaluationErrorInfo" }, "state": { "description": "Output only. The state of the evaluation run.", "type": "string", "readOnly": true, "enumDescriptions": [ "Evaluation run state is not specified.", "Indicates the evaluation run is queued.", "Evaluation run is running.", "Evaluation run has completed.", "The evaluation run has an error.", "Evaluation run was cancelled." ], "enum": [ "EVALUATION_RUN_STATE_UNSPECIFIED", "QUEUED", "RUNNING", "COMPLETED", "ERROR", "CANCELLED" ] }, "config": { "description": "Output only. The configuration used in the run.", "$ref": "EvaluationConfig", "readOnly": true }, "name": { "description": "Identifier. The unique identifier of the evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`", "type": "string" }, "scheduledEvaluationRun": { "description": "Output only. The scheduled evaluation run resource name that created this evaluation run. This field is only set if the evaluation run was created by a scheduled evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}`", "type": "string", "readOnly": true }, "evaluationType": { "readOnly": true, "enumDescriptions": [ "Evaluation type is not specified.", "Golden evaluation.", "Scenario evaluation.", "Indicates the run includes a mix of golden and scenario evaluations." ], "description": "Output only. The type of the evaluations in this run.", "type": "string", "enum": [ "EVALUATION_TYPE_UNSPECIFIED", "GOLDEN", "SCENARIO", "MIXED" ] }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the evaluation run was created.", "type": "string" }, "personaRunConfigs": { "description": "Output only. The configuration to use for the run per persona.", "type": "array", "readOnly": true, "items": { "$ref": "PersonaRunConfig" } }, "evaluationResults": { "readOnly": true, "description": "Output only. The evaluation results that are part of this run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`", "type": "array", "items": { "type": "string" } }, "evaluationRunSummaries": { "description": "Output only. Map of evaluation name to EvaluationRunSummary.", "type": "object", "readOnly": true, "additionalProperties": { "$ref": "EvaluationRunEvaluationRunSummary" } }, "goldenRunMethod": { "readOnly": true, "enumDescriptions": [ "Run method is not specified.", "Run the evaluation as stable replay, where each turn is a unique session with the previous expected turns injected as context.", "Run the evaluation as naive replay, where the run is a single session with no context injected." ], "description": "Output only. The method used to run the evaluation.", "type": "string", "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ] }, "changelog": { "readOnly": true, "description": "Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.", "type": "string" }, "appVersionDisplayName": { "readOnly": true, "description": "Output only. The display name of the `app_version` that the evaluation ran against.", "type": "string" }, "progress": { "readOnly": true, "description": "Output only. The progress of the evaluation run.", "$ref": "EvaluationRunProgress" }, "optimizationConfig": { "description": "Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run.", "$ref": "OptimizationConfig" }, "operation": { "description": "Output only. The operation that created this evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation}`", "type": "string", "readOnly": true }, "initiatedBy": { "readOnly": true, "description": "Output only. The user who initiated the evaluation run.", "type": "string" }, "evaluationDataset": { "readOnly": true, "description": "Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with `evaluations`. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "type": "string" }, "evaluations": { "items": { "type": "string" }, "readOnly": true, "description": "Output only. The evaluations that are part of this run. The list may contain evaluations of either type. This field is mutually exclusive with `evaluation_dataset`. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "type": "array" }, "error": { "description": "Output only. Deprecated: Use error_info instead. Errors encountered during execution.", "$ref": "Status", "readOnly": true, "deprecated": true }, "displayName": { "description": "Optional. User-defined display name of the evaluation run. default: \" run - \".", "type": "string" }, "latencyReport": { "readOnly": true, "description": "Output only. Latency report for the evaluation run.", "$ref": "LatencyReport" }, "runCount": { "description": "Output only. The number of times the evaluations inside the run were run.", "type": "integer", "readOnly": true, "format": "int32" }, "appVersion": { "readOnly": true, "description": "Output only. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "changelogCreateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.", "type": "string" } } }, "LfA2aV1OAuth2SecurityScheme": { "id": "LfA2aV1OAuth2SecurityScheme", "description": "Defines a security scheme using OAuth 2.0.", "type": "object", "properties": { "description": { "description": "An optional description for the security scheme.", "type": "string" }, "oauth2MetadataUrl": { "description": "URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.", "type": "string" }, "flows": { "description": "Required. An object containing configuration information for the supported OAuth 2.0 flows.", "$ref": "LfA2aV1OAuthFlows" } } }, "LfA2aV1PasswordOAuthFlow": { "properties": { "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" }, "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": { "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" } }, "description": "Deprecated: Use Authorization Code + PKCE or Device Code.", "type": "object", "id": "LfA2aV1PasswordOAuthFlow" }, "ExecuteToolRequest": { "description": "Request message for ToolService.ExecuteTool.", "type": "object", "id": "ExecuteToolRequest", "properties": { "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": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "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" }, "tool": { "description": "Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}", "type": "string" }, "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" }, "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" }, "variables": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The variables that are available for the tool execution.", "type": "object" } } }, "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", "id": "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" }, "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" } }, "flowId": { "description": "Optional. The flow ID of the flow in the Dialogflow agent.", "type": "string" }, "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" }, "inputVariableMapping": { "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", "additionalProperties": { "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" }, "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" } } }, "ChannelProfileWhatsAppConfig": { "properties": { "wabaId": { "description": "Required. The WhatsApp Business Account ID.", "type": "string" }, "thumbnailUrl": { "description": "Output only. The fetched Meta business profile thumbnail URL.", "type": "string", "readOnly": true }, "description": { "readOnly": true, "description": "Output only. The description of the Meta business page or profile.", "type": "string" }, "displayName": { "readOnly": true, "description": "Output only. The fetched Meta business page name.", "type": "string" }, "phoneNumber": { "description": "Optional. The phone number in E.164 format.", "type": "string" }, "phoneNumberId": { "description": "Required. The Meta phone number ID.", "type": "string" } }, "id": "ChannelProfileWhatsAppConfig", "description": "Configuration specific to WhatsApp deployments.", "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" }, "AggregatedMetricsMetricsByAppVersion": { "description": "Metrics aggregated per app version.", "type": "object", "id": "AggregatedMetricsMetricsByAppVersion", "properties": { "metricsByTurn": { "description": "Output only. Metrics aggregated per turn within this app version.", "type": "array", "readOnly": true, "items": { "$ref": "AggregatedMetricsMetricsByTurn" } }, "appVersionId": { "description": "Output only. The app version ID.", "type": "string", "readOnly": true }, "hallucinationMetrics": { "items": { "$ref": "AggregatedMetricsHallucinationMetrics" }, "description": "Output only. Metrics for hallucination within this app version.", "type": "array", "readOnly": true }, "toolMetrics": { "readOnly": true, "description": "Output only. Metrics for each tool within this app version.", "type": "array", "items": { "$ref": "AggregatedMetricsToolMetrics" } }, "failCount": { "format": "int32", "description": "Output only. The number of times the evaluation failed.", "type": "integer", "readOnly": true }, "turnLatencyMetrics": { "description": "Output only. Metrics for turn latency within this app version.", "type": "array", "readOnly": true, "items": { "$ref": "AggregatedMetricsTurnLatencyMetrics" } }, "passCount": { "readOnly": true, "description": "Output only. The number of times the evaluation passed.", "type": "integer", "format": "int32" }, "semanticSimilarityMetrics": { "description": "Output only. Metrics for semantic similarity within this app version.", "type": "array", "readOnly": true, "items": { "$ref": "AggregatedMetricsSemanticSimilarityMetrics" } }, "toolCallLatencyMetrics": { "readOnly": true, "description": "Output only. Metrics for tool call latency within this app version.", "type": "array", "items": { "$ref": "AggregatedMetricsToolCallLatencyMetrics" } } } }, "LfA2aV1DeviceCodeOAuthFlow": { "properties": { "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "tokenUrl": { "description": "Required. The token URL to be used for this flow.", "type": "string" }, "deviceAuthorizationUrl": { "description": "Required. The device authorization endpoint URL.", "type": "string" }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Required. The available scopes for the OAuth2 security scheme.", "type": "object" } }, "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", "id": "LfA2aV1DeviceCodeOAuthFlow" }, "LfA2aV1AgentSkill": { "id": "LfA2aV1AgentSkill", "description": "Represents a distinct capability or function that an agent can perform.", "type": "object", "properties": { "inputModes": { "items": { "type": "string" }, "description": "The set of supported input media types for this skill, overriding the agent's defaults.", "type": "array" }, "id": { "description": "Required. A unique identifier for the agent's skill.", "type": "string" }, "outputModes": { "description": "The set of supported output media types for this skill, overriding the agent's defaults.", "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" }, "tags": { "description": "Required. A set of keywords describing the skill's capabilities.", "type": "array", "items": { "type": "string" } }, "examples": { "items": { "type": "string" }, "description": "Example prompts or scenarios that this skill can handle.", "type": "array" }, "securityRequirements": { "items": { "$ref": "LfA2aV1SecurityRequirement" }, "description": "Security schemes necessary for this skill.", "type": "array" } } }, "QualityReportIssue": { "properties": { "proposedSolution": { "description": "Optional. Proposed solution to fix the issue by modifying instructions or tools.", "type": "string" }, "description": { "description": "Optional. Description of the issue found.", "type": "string" }, "occurrenceCount": { "format": "int32", "description": "Optional. How many times this issue occurred.", "type": "integer" } }, "description": "The issue identified.", "type": "object", "id": "QualityReportIssue" }, "AggregatedMetricsMetricsByTurn": { "properties": { "semanticSimilarityMetrics": { "readOnly": true, "description": "Output only. Metrics for semantic similarity within this turn.", "type": "array", "items": { "$ref": "AggregatedMetricsSemanticSimilarityMetrics" } }, "hallucinationMetrics": { "items": { "$ref": "AggregatedMetricsHallucinationMetrics" }, "description": "Output only. Metrics for hallucination within this turn.", "type": "array", "readOnly": true }, "turnLatencyMetrics": { "items": { "$ref": "AggregatedMetricsTurnLatencyMetrics" }, "readOnly": true, "description": "Output only. Metrics for turn latency within this turn.", "type": "array" }, "toolMetrics": { "items": { "$ref": "AggregatedMetricsToolMetrics" }, "description": "Output only. Metrics for each tool within this turn.", "type": "array", "readOnly": true }, "toolCallLatencyMetrics": { "description": "Output only. Metrics for tool call latency within this turn.", "type": "array", "readOnly": true, "items": { "$ref": "AggregatedMetricsToolCallLatencyMetrics" } }, "turnIndex": { "description": "Output only. The turn index (0-based).", "type": "integer", "readOnly": true, "format": "int32" } }, "description": "Metrics aggregated per turn.", "type": "object", "id": "AggregatedMetricsMetricsByTurn" }, "OAuthConfig": { "properties": { "clientId": { "description": "Required. The client ID from the OAuth provider.", "type": "string" }, "oauthGrantType": { "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)." ], "description": "Required. OAuth grant types.", "type": "string" }, "scopes": { "description": "Optional. The OAuth scopes to grant.", "type": "array", "items": { "type": "string" } }, "tokenEndpoint": { "description": "Required. The token endpoint in the OAuth provider to exchange for an access token.", "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" } }, "id": "OAuthConfig", "description": "Configurations for authentication with OAuth.", "type": "object" }, "CodeBlock": { "description": "A code block to be executed instead of a real tool call.", "type": "object", "id": "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" } } }, "ListEvaluationResultsResponse": { "description": "Response message for EvaluationService.ListEvaluationResults.", "type": "object", "id": "ListEvaluationResultsResponse", "properties": { "evaluationResults": { "description": "The list of evaluation results.", "type": "array", "items": { "$ref": "EvaluationResult" } }, "nextPageToken": { "description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } } }, "ChannelProfileWebWidgetConfigSecuritySettings": { "properties": { "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" }, "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" }, "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" } } }, "id": "ChannelProfileWebWidgetConfigSecuritySettings", "description": "Security settings for the web widget.", "type": "object" }, "LfA2aV1MutualTlsSecurityScheme": { "properties": { "description": { "description": "An optional description for the security scheme.", "type": "string" } }, "description": "Defines a security scheme using mTLS authentication.", "type": "object", "id": "LfA2aV1MutualTlsSecurityScheme" }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } } } }, "Message": { "description": "A message within a conversation.", "type": "object", "id": "Message", "properties": { "role": { "description": "Optional. The role within the conversation, e.g., user, agent.", "type": "string" }, "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" }, "chunks": { "description": "Optional. Content of the message as a series of chunks.", "type": "array", "items": { "$ref": "Chunk" } } } }, "EvaluationErrorInfo": { "properties": { "errorType": { "readOnly": true, "enumDescriptions": [ "Unspecified error type.", "Failure during runtime execution.", "Failure to retrieve conversation from CES Runtime.", "Failure to calculate a metric / outcome.", "Failure to update the evaluation.", "Ran out of quota.", "Failure during user simulation." ], "description": "Output only. The type of error.", "type": "string", "enum": [ "ERROR_TYPE_UNSPECIFIED", "RUNTIME_FAILURE", "CONVERSATION_RETRIEVAL_FAILURE", "METRIC_CALCULATION_FAILURE", "EVALUATION_UPDATE_FAILURE", "QUOTA_EXHAUSTED", "USER_SIMULATION_FAILURE" ] }, "userFacingErrorMessage": { "readOnly": true, "description": "Output only. The user facing error message.", "type": "string" }, "errorMessage": { "readOnly": true, "description": "Output only. The error message.", "type": "string" }, "sessionId": { "description": "Output only. The session ID for the conversation that caused the error.", "type": "string", "readOnly": true } }, "id": "EvaluationErrorInfo", "description": "Information about an error encountered during an evaluation execution.", "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" }, "GenerateAppResourceRequestAppVersionContext": { "id": "GenerateAppResourceRequestAppVersionContext", "description": "The app version context specifying the base snapshot and target agent.", "type": "object", "properties": { "appVersion": { "description": "The resource name of the app version to be used by the LLM assistant. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "agentResourceName": { "description": "The resource name of the target agent to be used by the LLM assistant. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" } } }, "AggregatedMetricsToolCallLatencyMetrics": { "properties": { "tool": { "readOnly": true, "description": "Output only. The name of the tool.", "type": "string" }, "averageLatency": { "format": "google-duration", "description": "Output only. The average latency of the tool calls.", "type": "string", "readOnly": true } }, "id": "AggregatedMetricsToolCallLatencyMetrics", "description": "Metrics for tool call latency.", "type": "object" }, "ExperimentConfigVersionReleaseTrafficAllocation": { "id": "ExperimentConfigVersionReleaseTrafficAllocation", "description": "Traffic allocation for the version release.", "type": "object", "properties": { "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": { "description": "Optional. Id of the traffic allocation. Free format string, up to 128 characters.", "type": "string" } } }, "EvaluationScenarioExpectation": { "description": "The expectation to evaluate the conversation produced by the simulation.", "type": "object", "id": "EvaluationScenarioExpectation", "properties": { "toolExpectation": { "description": "Optional. The tool call and response pair to be evaluated.", "$ref": "EvaluationScenarioExpectationToolExpectation" }, "agentResponse": { "description": "Optional. The agent response to be evaluated.", "$ref": "Message" } } }, "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" }, "semanticSimilarityChannel": { "enumDescriptions": [ "Metric unspecified. Defaults to TEXT.", "Use text semantic similarity.", "Use audio semantic similarity." ], "description": "Optional. The semantic similarity channel to use for evaluation.", "type": "string", "enum": [ "SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED", "TEXT", "AUDIO" ] }, "overallToolInvocationCorrectnessThreshold": { "format": "float", "description": "Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.", "type": "number" } }, "description": "Turn level metrics thresholds.", "type": "object", "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds" }, "EvaluationGolden": { "properties": { "turns": { "items": { "$ref": "EvaluationGoldenTurn" }, "description": "Required. The golden turns required to replay a golden conversation. The maximum number of allowed turns is 100.", "type": "array" }, "evaluationExpectations": { "description": "Optional. The evaluation expectations to evaluate the replayed conversation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}`", "type": "array", "items": { "type": "string" } } }, "description": "The steps required to replay a golden conversation.", "type": "object", "id": "EvaluationGolden" }, "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig": { "description": "The configuration to be used to generate an operation in the Open API schema.", "type": "object", "id": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig", "properties": { "path": { "description": "Required. The path of the tool to be appended to the base uri. This should include query and path parameters if any.", "type": "string" }, "requestJson": { "description": "Required. A sample request to the tool in JSON format. Skip if the tool does not support request body.", "type": "string" }, "method": { "description": "Required. The uri of the tool. This should include query and path parameters if any.", "type": "string" }, "responseJson": { "description": "Required. A sample response from the tool in JSON format.", "type": "string" } } }, "EvaluationResultGoldenResult": { "properties": { "turnReplayResults": { "items": { "$ref": "EvaluationResultGoldenResultTurnReplayResult" }, "description": "Output only. The result of running each turn of the golden conversation.", "type": "array", "readOnly": true }, "evaluationExpectationResults": { "items": { "$ref": "EvaluationResultEvaluationExpectationResult" }, "readOnly": true, "description": "Output only. The results of the evaluation expectations.", "type": "array" } }, "description": "The result of a golden evaluation.", "type": "object", "id": "EvaluationResultGoldenResult" }, "ExportEvaluationRunsRequest": { "id": "ExportEvaluationRunsRequest", "description": "Request message for EvaluationService.ExportEvaluationRuns.", "type": "object", "properties": { "exportOptions": { "description": "Optional. The export options for the evaluation runs.", "$ref": "ExportOptions" }, "names": { "items": { "type": "string" }, "description": "Required. The resource names of the evaluation runs to export.", "type": "array" } } }, "ServiceAccountAuthConfig": { "id": "ServiceAccountAuthConfig", "description": "Configurations for authentication using a custom service account.", "type": "object", "properties": { "scopes": { "description": "Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.", "type": "array", "items": { "type": "string" } }, "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" } } }, "EvaluationResultOverallToolInvocationResult": { "description": "The result of the overall tool invocation check.", "type": "object", "id": "EvaluationResultOverallToolInvocationResult", "properties": { "toolInvocationScore": { "format": "float", "description": "The overall tool invocation score for this turn. This indicates the overall percent of tools from the expected turn that were actually invoked.", "type": "number" }, "outcome": { "readOnly": true, "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ], "description": "Output only. The outcome of the tool invocation check. This is determined by comparing the tool_invocation_score to the overall_tool_invocation_correctness_threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.", "type": "string", "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ] } } }, "AgentInterface": { "properties": { "tenant": { "description": "Tenant ID to be used in the request when calling the agent.", "type": "string" }, "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" }, "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" }, "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" } }, "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" }, "ExportEvaluationResultsResponse": { "properties": { "evaluationResultsContent": { "format": "byte", "description": "The content of the exported Evaluation Results. This will be populated if gcs_uri was not specified in the request.", "type": "string" }, "evaluationResultsUri": { "description": "The Google Cloud Storage URI folder where the exported Evaluation Results were written. This will be populated if gcs_uri was specified in the request.", "type": "string" } }, "id": "ExportEvaluationResultsResponse", "description": "Response message for EvaluationService.ExportEvaluationResults.", "type": "object" }, "LfA2aV1SendMessageRequest": { "id": "LfA2aV1SendMessageRequest", "description": "Represents a request for the `SendMessage` method.", "type": "object", "properties": { "configuration": { "description": "Configuration for the send request.", "$ref": "LfA2aV1SendMessageConfiguration" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "A flexible key-value map for passing additional context or parameters.", "type": "object" }, "message": { "description": "Required. The message to send to the agent.", "$ref": "LfA2aV1Message" } } }, "ListOperationsResponse": { "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" }, "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" } } }, "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object" }, "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", "id": "Empty", "properties": {} }, "EvaluationMetricsThresholds": { "description": "Threshold settings for metrics in an Evaluation.", "type": "object", "id": "EvaluationMetricsThresholds", "properties": { "goldenEvaluationMetricsThresholds": { "description": "Optional. The golden evaluation metrics thresholds.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds" }, "hallucinationMetricBehavior": { "deprecated": true, "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" }, "goldenHallucinationMetricBehavior": { "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ], "description": "Optional. The hallucination metric behavior for golden evaluations.", "type": "string" }, "scenarioHallucinationMetricBehavior": { "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "description": "Optional. The hallucination metric behavior for scenario evaluations.", "type": "string", "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ] } } }, "EvaluationConfig": { "properties": { "outputAudioConfig": { "description": "Optional. Configuration for generating the output audio.", "$ref": "OutputAudioConfig" }, "evaluationChannel": { "enum": [ "EVALUATION_CHANNEL_UNSPECIFIED", "TEXT", "AUDIO" ], "description": "Optional. The channel to evaluate.", "type": "string", "enumDescriptions": [ "Unspecified evaluation channel.", "Text-only evaluation channel.", "Audio evaluation channel." ] }, "inputAudioConfig": { "description": "Optional. Configuration for processing the input audio.", "$ref": "InputAudioConfig" }, "toolCallBehaviour": { "enum": [ "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED", "REAL", "FAKE" ], "enumDescriptions": [ "Unspecified tool call behavior. Will default to real tool calls.", "Use real tool calls.", "Use fake tool calls." ], "description": "Optional. Specifies whether the evaluation should use real tool calls or fake tools.", "type": "string" } }, "description": "EvaluationConfig configures settings for running the evaluation.", "type": "object", "id": "EvaluationConfig" }, "RunSessionResponse": { "properties": { "outputs": { "items": { "$ref": "SessionOutput" }, "description": "Outputs for the session.", "type": "array" } }, "description": "Response message for SessionService.RunSession.", "type": "object", "id": "RunSessionResponse" }, "ExportEvaluationResultsRequest": { "properties": { "names": { "items": { "type": "string" }, "description": "Required. The resource names of the evaluation results to export.", "type": "array" }, "exportOptions": { "description": "Optional. The export options for the evaluation results.", "$ref": "ExportOptions" } }, "id": "ExportEvaluationResultsRequest", "description": "Request message for EvaluationService.ExportEvaluationResults.", "type": "object" }, "EvaluationRunEvaluationRunSummary": { "id": "EvaluationRunEvaluationRunSummary", "description": "Contains the summary of passed and failed result counts for a specific evaluation in an evaluation run.", "type": "object", "properties": { "failedCount": { "format": "int32", "description": "Output only. Number of failed results for the associated Evaluation in this run.", "type": "integer", "readOnly": true }, "passedCount": { "description": "Output only. Number of passed results for the associated Evaluation in this run.", "type": "integer", "readOnly": true, "format": "int32" }, "errorCount": { "format": "int32", "readOnly": true, "description": "Output only. Number of error results for the associated Evaluation in this run.", "type": "integer" } } }, "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" }, "location": { "description": "Required. The location of the API key. Valid values are \"query\", \"header\", or \"cookie\".", "type": "string" }, "name": { "description": "Required. The name of the header, query, or cookie parameter to be used.", "type": "string" } } }, "WhatsAppCredentials": { "properties": { "authCode": { "description": "Required. The Meta auth code provided by the embedded signup flow.", "type": "string" }, "pin": { "description": "Required. The 6-digit PIN created by the user for two-step verification.", "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" }, "wabaId": { "description": "Required. The WhatsApp Business Account ID.", "type": "string" }, "conversationProfileId": { "description": "Optional. The Conversation Profile ID to use for the deployment.", "type": "string" } }, "id": "WhatsAppCredentials", "description": "Ephemeral Meta credentials for WhatsApp native integration.", "type": "object" }, "DataStore": { "properties": { "displayName": { "description": "Output only. The display name of the data store.", "type": "string", "readOnly": true }, "connectorConfig": { "description": "Output only. The connector config for the data store connection.", "$ref": "DataStoreConnectorConfig", "readOnly": true }, "type": { "description": "Output only. The type of the data store. This field is readonly and populated by the server.", "type": "string", "readOnly": true, "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" ] }, "createTime": { "readOnly": true, "description": "Output only. Timestamp when the data store was created.", "type": "string", "format": "google-datetime" }, "name": { "description": "Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", "type": "string" }, "documentProcessingMode": { "enum": [ "DOCUMENT_PROCESSING_MODE_UNSPECIFIED", "DOCUMENTS", "CHUNKS" ], "readOnly": true, "enumDescriptions": [ "Not specified.", "Documents are processed as documents.", "Documents are converted to chunks." ], "description": "Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.", "type": "string" } }, "description": "A DataStore resource in Vertex AI Search.", "type": "object", "id": "DataStore" }, "RunEvaluationRequest": { "id": "RunEvaluationRequest", "description": "Request message for EvaluationService.RunEvaluation.", "type": "object", "properties": { "displayName": { "description": "Optional. The display name of the evaluation run.", "type": "string" }, "runCount": { "description": "Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario.", "type": "integer", "format": "int32" }, "personaRunConfigs": { "items": { "$ref": "PersonaRunConfig" }, "description": "Optional. The configuration to use for the run per persona.", "type": "array" }, "appVersion": { "description": "Optional. The app version to evaluate. At most one of `app_version` or `deployment` can be set. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "goldenRunMethod": { "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ], "enumDescriptions": [ "Run method is not specified.", "Run the evaluation as stable replay, where each turn is a unique session with the previous expected turns injected as context.", "Run the evaluation as naive replay, where the run is a single session with no context injected." ], "description": "Optional. The method to run the evaluation if it is a golden evaluation. If not set, default to STABLE.", "type": "string" }, "generateLatencyReport": { "description": "Optional. Whether to generate a latency report for the evaluation run.", "type": "boolean" }, "evaluationRunCachingSettings": { "description": "Optional. The caching settings to use for the evaluation run.", "$ref": "EvaluationRunCachingSettings" }, "app": { "description": "Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string" }, "optimizationConfig": { "description": "Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run.", "$ref": "OptimizationConfig" }, "config": { "description": "Optional. The configuration to use for the run.", "$ref": "EvaluationConfig" }, "scheduledEvaluationRun": { "description": "Optional. The resource name of the `ScheduledEvaluationRun` that is triggering this evaluation run. If this field is set, the `scheduled_evaluation_run` field on the created `EvaluationRun` resource will be populated from this value. Format: `projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}`", "type": "string" }, "evaluationDataset": { "description": "Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "type": "string" }, "evaluations": { "items": { "type": "string" }, "description": "Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "type": "array" } } }, "AmbientSoundConfig": { "description": "Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.", "type": "object", "id": "AmbientSoundConfig", "properties": { "prebuiltAmbientNoise": { "deprecated": true, "enum": [ "PREBUILT_AMBIENT_NOISE_UNSPECIFIED", "RETAIL_STORE", "CONVENTION_HALL", "OUTDOOR" ], "enumDescriptions": [ "Not specified.", "Ambient noise of a retail store.", "Ambient noise of a convention hall.", "Ambient noise of a street." ], "description": "Optional. Deprecated: `prebuilt_ambient_noise` is deprecated in favor of `prebuilt_ambient_sound`.", "type": "string" }, "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" }, "volumeGainDb": { "format": "double", "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" } } }, "SystemTool": { "description": "Pre-defined system tool.", "type": "object", "id": "SystemTool", "properties": { "name": { "description": "Required. The name of the system tool.", "type": "string" }, "description": { "description": "Output only. The description of the system tool.", "type": "string", "readOnly": true } } }, "TimeZoneSettings": { "description": "TimeZone settings of the app.", "type": "object", "id": "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" } } }, "EvaluationMetricsConfigSemanticSimilarityMetricsConfig": { "properties": { "enableSemanticSimilarityMetrics": { "description": "Optional. Whether to calculate semantic similarity metrics for the evaluation.", "type": "boolean" } }, "description": "Configuration for similarity metrics for the evaluation. To disable the metric, set the message but do not set the `enable_semantic_similarity_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", "type": "object", "id": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig" }, "EvaluationResult": { "properties": { "scenarioResult": { "description": "Output only. The outcome of a scenario evaluation.", "$ref": "EvaluationResultScenarioResult", "readOnly": true }, "evaluationMetricsThresholds": { "description": "Output only. The evaluation thresholds for the result.", "$ref": "EvaluationMetricsThresholds", "readOnly": true }, "evaluationRun": { "description": "Output only. The evaluation run that produced this result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`", "type": "string", "readOnly": true }, "appVersionDisplayName": { "description": "Output only. The display name of the `app_version` that the evaluation ran against.", "type": "string", "readOnly": true }, "outcomeMetadata": { "description": "Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE.", "type": "string", "readOnly": true, "enumDescriptions": [ "Unspecified outcome metadata.", "The evaluation resulted in a graceful handoff to a human representative." ], "enum": [ "OUTCOME_METADATA_UNSPECIFIED", "GRACEFUL_HANDOFF" ] }, "changelog": { "readOnly": true, "description": "Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.", "type": "string" }, "goldenRunMethod": { "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ], "description": "Output only. The method used to run the golden evaluation.", "type": "string", "readOnly": true, "enumDescriptions": [ "Run method is not specified.", "Run the evaluation as stable replay, where each turn is a unique session with the previous expected turns injected as context.", "Run the evaluation as naive replay, where the run is a single session with no context injected." ] }, "persona": { "readOnly": true, "description": "Output only. The persona used to generate the conversation for the evaluation result.", "$ref": "EvaluationPersona" }, "appVersion": { "readOnly": true, "description": "Output only. The app version used to generate the conversation that resulted in this result. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "changelogCreateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.", "type": "string" }, "displayName": { "description": "Required. Display name of the Evaluation Result. Unique within an Evaluation. By default, it has the following format: \" result - \".", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. Timestamp when the evaluation result was created.", "type": "string", "format": "google-datetime" }, "name": { "description": "Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`", "type": "string" }, "error": { "description": "Output only. Deprecated: Use `error_info` instead. Errors encountered during execution.", "$ref": "Status", "readOnly": true, "deprecated": true }, "rootSpan": { "description": "Output only. The root span of the evaluation execution, which includes information about each step of the evaluation.", "$ref": "Span", "readOnly": true }, "errorInfo": { "readOnly": true, "description": "Output only. Error information for the evaluation result.", "$ref": "EvaluationErrorInfo" }, "evaluationStatus": { "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "readOnly": true, "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ], "description": "Output only. The outcome of the evaluation. Only populated if execution_state is COMPLETE.", "type": "string" }, "config": { "readOnly": true, "description": "Output only. The configuration used in the evaluation run that resulted in this result.", "$ref": "EvaluationConfig" }, "executionState": { "enum": [ "EXECUTION_STATE_UNSPECIFIED", "QUEUED", "RUNNING", "COMPLETED", "ERROR", "CANCELLED" ], "readOnly": true, "enumDescriptions": [ "Evaluation result execution state is not specified.", "Evaluation result execution is queued.", "Evaluation result execution is running.", "Evaluation result execution has completed.", "Evaluation result execution failed due to an internal error.", "Evaluation result execution was cancelled." ], "description": "Output only. The state of the evaluation result execution.", "type": "string" }, "goldenResult": { "description": "Output only. The outcome of a golden evaluation.", "$ref": "EvaluationResultGoldenResult", "readOnly": true }, "initiatedBy": { "readOnly": true, "description": "Output only. The user who initiated the evaluation run that resulted in this result.", "type": "string" } }, "id": "EvaluationResult", "description": "An evaluation result represents the output of running an Evaluation.", "type": "object" }, "ExportEvaluationsRequest": { "properties": { "includeEvaluations": { "description": "Optional. Includes evaluations in the export. At least one of include_evaluation_results or include_evaluations must be set.", "type": "boolean" }, "names": { "items": { "type": "string" }, "description": "Required. The resource names of the evaluations to export.", "type": "array" }, "exportOptions": { "description": "Optional. The export options for the evaluations.", "$ref": "ExportOptions" }, "includeEvaluationResults": { "description": "Optional. Includes evaluation results in the export. At least one of include_evaluation_results or include_evaluations must be set.", "type": "boolean" } }, "id": "ExportEvaluationsRequest", "description": "Request message for EvaluationService.ExportEvaluations.", "type": "object" }, "DataStoreToolBoostSpec": { "properties": { "conditionBoostSpecs": { "items": { "$ref": "DataStoreToolBoostSpecConditionBoostSpec" }, "description": "Required. A list of boosting specifications.", "type": "array" } }, "description": "Boost specification to boost certain documents.", "type": "object", "id": "DataStoreToolBoostSpec" }, "RunEvaluationResultMetricsRequest": { "properties": {}, "id": "RunEvaluationResultMetricsRequest", "description": "Request message for EvaluationService.RunEvaluationResultMetrics.", "type": "object" }, "EvaluationResultToolCallLatency": { "id": "EvaluationResultToolCallLatency", "description": "The latency of a tool call execution.", "type": "object", "properties": { "displayName": { "description": "Output only. The display name of the tool.", "type": "string", "readOnly": true }, "executionLatency": { "description": "Output only. The latency of the tool call execution.", "type": "string", "readOnly": true, "format": "google-duration" }, "tool": { "description": "Output only. The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.", "type": "string", "readOnly": true }, "endTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The end time of the tool call execution.", "type": "string" }, "startTime": { "description": "Output only. The start time of the tool call execution.", "type": "string", "readOnly": true, "format": "google-datetime" } } }, "RestoreAppVersionRequest": { "properties": {}, "id": "RestoreAppVersionRequest", "description": "Request message for AgentService.RestoreAppVersion", "type": "object" }, "EvaluationScenarioExpectationToolExpectation": { "properties": { "mockToolResponse": { "description": "Required. The tool response to mock, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM.", "$ref": "ToolResponse" }, "expectedToolCall": { "description": "Required. The expected tool call, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM.", "$ref": "ToolCall" } }, "id": "EvaluationScenarioExpectationToolExpectation", "description": "The tool call and response pair to be evaluated.", "type": "object" }, "GenerateAppResourceRequest": { "properties": { "refineInstructions": { "description": "Optional. List of refine instructions to be used to refine the resource.", "type": "array", "items": { "$ref": "GenerateAppResourceRequestRefineInstructions" } }, "appGenerationConfig": { "description": "Optional. The configuration to be used to generate the agents and tools.", "$ref": "GenerateAppResourceRequestAppGenerationConfig" }, "evaluationGenerationConfig": { "description": "Optional. The configuration to be used to generate the evaluations.", "$ref": "GenerateAppResourceRequestEvaluationGenerationConfig" }, "hillClimbingFixConfig": { "description": "Optional. The configuration to be used for hill climbing fixes.", "$ref": "GenerateAppResourceRequestHillClimbingFixConfig" }, "appVersionContext": { "description": "The app version context specifying the base snapshot and target agent.", "$ref": "GenerateAppResourceRequestAppVersionContext" }, "tool": { "description": "The tool resource to be used by the LLM assistant, can be empty for generating a new tool.", "$ref": "Tool" }, "toolGenerationConfig": { "description": "Optional. The configuration to be used to generate the tool.", "$ref": "GenerateAppResourceRequestToolGenerationConfig" }, "evaluationPersonasGenerationConfig": { "description": "Optional. The configuration to be used to generate the evaluation personas.", "$ref": "GenerateAppResourceRequestEvaluationPersonasGenerationConfig" }, "qualityReportGenerationConfig": { "description": "Optional. The configuration to be used for quality report generation.", "$ref": "GenerateAppResourceRequestQualityReportGenerationConfig" }, "agent": { "description": "The agent resource to be used by the LLM assistant, can be empty for generating a new agent.", "$ref": "Agent" }, "toolset": { "description": "The toolset resource to be used by the LLM assistant, can be empty for generating a new toolset.", "$ref": "Toolset" } }, "id": "GenerateAppResourceRequest", "description": "Request message for AgentService.GenerateAppResource.", "type": "object" }, "EvaluationMetricsConfigUserGoalMetMetricsConfig": { "properties": { "enableUserGoalMetMetrics": { "description": "Optional. Whether to calculate the user goal met metrics for the evaluation.", "type": "boolean" } }, "id": "EvaluationMetricsConfigUserGoalMetMetricsConfig", "description": "Configuration for the user goal met metrics for the evaluation. To disable the metric, set the message but do not set the `enable_user_goal_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", "type": "object" }, "DataStoreSettings": { "description": "Data store related settings for the app.", "type": "object", "id": "DataStoreSettings", "properties": { "engines": { "items": { "$ref": "DataStoreSettingsEngine" }, "description": "Output only. The engines for the app.", "type": "array", "readOnly": true } } }, "ConnectorToolset": { "id": "ConnectorToolset", "description": "A toolset that generates tools from an Integration Connectors Connection.", "type": "object", "properties": { "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" }, "connectorActions": { "description": "Required. The list of connector actions/entity operations to generate tools for.", "type": "array", "items": { "$ref": "Action" } } } }, "CitationsCitedChunk": { "description": "Piece of cited information.", "type": "object", "id": "CitationsCitedChunk", "properties": { "uri": { "description": "URI used for citation.", "type": "string" }, "requiresAttribution": { "description": "Whether this citation requires attribution to be shown to the end users.", "type": "boolean" }, "text": { "description": "Text used for citation.", "type": "string" }, "title": { "description": "Title of the cited document.", "type": "string" } } }, "EvaluationResultScenarioExpectationOutcome": { "description": "The outcome of a scenario expectation.", "type": "object", "id": "EvaluationResultScenarioExpectationOutcome", "properties": { "observedAgentResponse": { "readOnly": true, "description": "Output only. The observed agent response.", "$ref": "Message" }, "observedToolCall": { "readOnly": true, "description": "Output only. The observed tool call.", "$ref": "EvaluationResultScenarioExpectationOutcomeObservedToolCall" }, "expectation": { "readOnly": true, "description": "Output only. The expectation that was evaluated.", "$ref": "EvaluationScenarioExpectation" }, "outcome": { "description": "Output only. The outcome of the ScenarioExpectation.", "type": "string", "readOnly": true, "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ], "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ] } } }, "ImportEvaluationsOperationMetadata": { "id": "ImportEvaluationsOperationMetadata", "description": "Represents the metadata of the long-running operation for EvaluationService.ImportEvaluations.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" }, "statusMessage": { "readOnly": true, "description": "Output only. Human-readable status of the operation, if any.", "type": "string" } } }, "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", "id": "GoogleSearchTool", "properties": { "name": { "description": "Required. The name of the tool.", "type": "string" }, "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" } }, "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" }, "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" } } }, "GenerateAppResourceResponse": { "properties": { "generateResultInfo": { "description": "Additional information about the generated result.", "$ref": "GenerateAppResourceResponseGenerateResultInfo" }, "evaluations": { "description": "Evaluations generated by the LLM assistant.", "$ref": "GenerateAppResourceResponseEvaluations" }, "qualityReport": { "description": "The quality report generated by the LLM assistant.", "$ref": "QualityReport" }, "appSnapshot": { "description": "App snapshot generated by the LLM assistant. This snapshot contains the app, agents & tools generated by the LLM assistant.", "$ref": "AppSnapshot" }, "toolset": { "description": "Toolset generated by the LLM assistant. Supports Open API toolset schema generation.", "$ref": "Toolset" }, "tools": { "description": "The list of tools generated by the LLM assistant.", "$ref": "GenerateAppResourceResponseTools" }, "agent": { "description": "Agent generated by the LLM assistant.", "$ref": "Agent" }, "appResources": { "description": "The app resources generated by the LLM assistant.", "$ref": "GenerateAppResourceResponseAppResources" } }, "description": "Response message for AgentService.GenerateAppResource.", "type": "object", "id": "GenerateAppResourceResponse" }, "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" }, "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" }, "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" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "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." } } }, "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "id": "Operation" }, "CloudLoggingSettings": { "id": "CloudLoggingSettings", "description": "Settings to describe the Cloud Logging behaviors for the app.", "type": "object", "properties": { "enableCloudLogging": { "description": "Optional. Whether to enable Cloud Logging for the sessions.", "type": "boolean" } } }, "DataStoreToolRewriterConfig": { "id": "DataStoreToolRewriterConfig", "description": "Rewriter configuration.", "type": "object", "properties": { "modelSettings": { "description": "Required. Configurations for the LLM model.", "$ref": "ModelSettings" }, "prompt": { "description": "Optional. The prompt definition. If not set, default prompt will be used.", "type": "string" }, "disabled": { "description": "Optional. Whether the rewriter is disabled.", "type": "boolean" } } }, "ImportEvaluationsRequestImportOptions": { "description": "Configuration options for the evaluation import process. These options control how the import behaves, particularly when conflicts arise with existing evaluations data.", "type": "object", "id": "ImportEvaluationsRequestImportOptions", "properties": { "conflictResolutionStrategy": { "enumDescriptions": [ "The conflict resolution strategy is unspecified.", "Overwrite the existing evaluation with the new one.", "Keep the existing evaluation and skip the new one.", "Keep the existing evaluation and duplicate the new one as a new evaluation." ], "description": "Optional. The strategy to use when resolving conflicts during import.", "type": "string", "enum": [ "CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED", "OVERWRITE", "SKIP", "DUPLICATE" ] } } }, "LatencyReportLlmCallLatency": { "description": "Latency metrics for a single LLM call.", "type": "object", "id": "LatencyReportLlmCallLatency", "properties": { "model": { "readOnly": true, "description": "Output only. The name of the model.", "type": "string" }, "latencyMetrics": { "readOnly": true, "description": "Output only. The latency metrics for the LLM call.", "$ref": "LatencyReportLatencyMetrics" } } }, "RunEvaluationResultMetricsResponse": { "properties": { "status": { "description": "Output only. The status of the evaluation result metrics calculation.", "type": "string", "readOnly": true, "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ], "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ] } }, "description": "Response message for EvaluationService.RunEvaluationResultMetrics.", "type": "object", "id": "RunEvaluationResultMetricsResponse" }, "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": { "description": { "description": "Optional. The tool description.", "type": "string" }, "name": { "description": "Required. The tool name.", "type": "string" }, "corpusType": { "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." ], "description": "Optional. The type of the corpus. Default is FULLY_MANAGED.", "type": "string" }, "fileCorpus": { "description": "Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}", "type": "string" } } }, "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", "id": "LfA2aV1AgentCard", "properties": { "documentationUrl": { "description": "A URL providing additional documentation about the agent.", "type": "string" }, "signatures": { "description": "JSON Web Signatures computed for this `AgentCard`.", "type": "array", "items": { "$ref": "LfA2aV1AgentCardSignature" } }, "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" }, "securitySchemes": { "additionalProperties": { "$ref": "LfA2aV1SecurityScheme" }, "description": "The security scheme details used for authenticating with this agent.", "type": "object" }, "capabilities": { "description": "Required. A2A Capability set supported by the agent.", "$ref": "LfA2aV1AgentCapabilities" }, "provider": { "description": "The service provider of the agent.", "$ref": "LfA2aV1AgentProvider" }, "defaultOutputModes": { "description": "Required. The media types supported as outputs from this agent.", "type": "array", "items": { "type": "string" } }, "securityRequirements": { "description": "Security requirements for contacting the agent.", "type": "array", "items": { "$ref": "LfA2aV1SecurityRequirement" } }, "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" }, "version": { "description": "Required. The version of the agent. Example: \"1.0.0\"", "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" }, "supportedInterfaces": { "description": "Required. Ordered list of supported interfaces. The first entry is preferred.", "type": "array", "items": { "$ref": "LfA2aV1AgentInterface" } }, "name": { "description": "Required. A human readable name for the agent. Example: \"Recipe Agent\"", "type": "string" } } }, "EvaluationResultSpanLatency": { "description": "The latency of a span execution.", "type": "object", "id": "EvaluationResultSpanLatency", "properties": { "resource": { "readOnly": true, "description": "Output only. The resource name of the guardrail or tool spans.", "type": "string" }, "endTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The end time of span.", "type": "string" }, "type": { "enum": [ "TYPE_UNSPECIFIED", "TOOL", "USER_CALLBACK", "GUARDRAIL", "LLM" ], "description": "Output only. The type of span.", "type": "string", "readOnly": true, "enumDescriptions": [ "Default value. This value is unused.", "Tool call span.", "User callback span.", "Guardrail span.", "LLM span." ] }, "executionLatency": { "readOnly": true, "description": "Output only. The latency of span.", "type": "string", "format": "google-duration" }, "toolset": { "readOnly": true, "description": "Output only. The toolset tool identifier.", "$ref": "ToolsetTool" }, "model": { "description": "Output only. The name of the LLM span.", "type": "string", "readOnly": true }, "startTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The start time of span.", "type": "string" }, "displayName": { "description": "Output only. The display name of the span. Applicable to tool and guardrail spans.", "type": "string", "readOnly": true }, "callback": { "description": "Output only. The name of the user callback span.", "type": "string", "readOnly": true } } }, "Evaluation": { "id": "Evaluation", "description": "An evaluation represents all of the information needed to simulate and evaluate an agent.", "type": "object", "properties": { "golden": { "description": "Optional. The golden steps to be evaluated.", "$ref": "EvaluationGolden" }, "scenario": { "description": "Optional. The config for a scenario.", "$ref": "EvaluationScenario" }, "lastCompletedResult": { "readOnly": true, "description": "Output only. The latest evaluation result for this evaluation.", "$ref": "EvaluationResult" }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the evaluation was created.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. Timestamp when the evaluation was last updated.", "type": "string", "format": "google-datetime" }, "displayName": { "description": "Required. User-defined display name of the evaluation. Unique within an App.", "type": "string" }, "createdBy": { "description": "Output only. The user who created the evaluation.", "type": "string", "readOnly": true }, "evaluationRuns": { "readOnly": true, "description": "Output only. The EvaluationRuns that this Evaluation is associated with.", "type": "array", "items": { "type": "string" } }, "aggregatedMetrics": { "description": "Output only. The aggregated metrics for this evaluation across all runs.", "$ref": "AggregatedMetrics", "readOnly": true }, "tags": { "description": "Optional. User defined tags to categorize the evaluation.", "type": "array", "items": { "type": "string" } }, "invalid": { "description": "Output only. Whether the evaluation is invalid. This can happen if an evaluation is referencing a tool, toolset, or agent that has since been deleted.", "type": "boolean", "readOnly": true }, "lastTenResults": { "items": { "$ref": "EvaluationResult" }, "readOnly": true, "description": "Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.", "type": "array" }, "evaluationDatasets": { "items": { "type": "string" }, "description": "Output only. List of evaluation datasets the evaluation belongs to. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "type": "array", "readOnly": true }, "lastUpdatedBy": { "readOnly": true, "description": "Output only. The user who last updated the evaluation.", "type": "string" }, "name": { "description": "Identifier. The unique identifier of this evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "type": "string" }, "evaluationMetricsThresholdOverride": { "description": "Optional. Overrides metrics thresholds for this specific evaluation.", "$ref": "EvaluationMetricsThresholds" }, "description": { "description": "Optional. User-defined description of the evaluation.", "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.", "type": "string", "readOnly": true }, "evaluationMetricsConfigOverride": { "description": "Optional. Overrides metrics config for this specific evaluation.", "$ref": "EvaluationMetricsConfig" } } }, "SynthesizeSpeechConfig": { "properties": { "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" }, "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 }, "consentAudioGcsUri": { "description": "Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the consent audio for voice cloning.", "type": "string", "deprecated": true }, "speakingRate": { "format": "double", "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" }, "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" }, "instruction": { "description": "Optional. The instruction used to synthesize speech when using a generative model.", "type": "string" } }, "id": "SynthesizeSpeechConfig", "description": "Configuration for how the agent response should be synthesized.", "type": "object" }, "PythonFunction": { "properties": { "pythonCode": { "description": "Optional. The Python code to execute for the tool.", "type": "string" }, "description": { "description": "Output only. The description of the Python function, parsed from the python code's docstring.", "type": "string", "readOnly": true }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration for the tool.", "$ref": "ServiceDirectoryConfig" }, "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": "A Python function tool.", "type": "object", "id": "PythonFunction" }, "SessionInput": { "id": "SessionInput", "description": "Input for the session.", "type": "object", "properties": { "text": { "description": "Optional. Text data from the end user.", "type": "string" }, "audio": { "format": "byte", "description": "Optional. Audio data from the end user.", "type": "string" }, "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" }, "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" }, "blob": { "description": "Optional. Blob data from the end user.", "$ref": "Blob" }, "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" }, "event": { "description": "Optional. Event input.", "$ref": "Event" }, "dtmf": { "description": "Optional. DTMF digits from the end user.", "type": "string" } } }, "Conversation": { "id": "Conversation", "description": "A conversation represents an interaction between an end user and the CES app.", "type": "object", "properties": { "source": { "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "description": "Output only. Indicate the source of the conversation.", "type": "string", "readOnly": true, "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." ] }, "name": { "description": "Identifier. The unique identifier of the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`", "type": "string" }, "inputTypes": { "description": "Output only. The input types of the conversation.", "type": "array", "readOnly": true, "items": { "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." ], "type": "string" } }, "languageCode": { "readOnly": true, "description": "Output only. The language code of the conversation.", "type": "string" }, "turnCount": { "format": "int32", "readOnly": true, "description": "Output only. The number of turns in the conversation.", "type": "integer" }, "startTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the conversation was created.", "type": "string" }, "channelType": { "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." ], "deprecated": true, "enum": [ "CHANNEL_TYPE_UNSPECIFIED", "TEXT", "AUDIO", "MULTIMODAL" ] }, "messages": { "deprecated": true, "items": { "$ref": "Message" }, "description": "Deprecated. Use turns instead.", "type": "array" }, "turns": { "items": { "$ref": "ConversationTurn" }, "description": "Required. The turns in the conversation.", "type": "array" }, "endTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the conversation was completed.", "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}`", "type": "string", "readOnly": true }, "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}`", "type": "string", "readOnly": true }, "appVersion": { "description": "Output only. The version of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string", "readOnly": true } } }, "LfA2aV1TaskPushNotificationConfig": { "id": "LfA2aV1TaskPushNotificationConfig", "description": "A container associating a push notification configuration with a specific task.", "type": "object", "properties": { "taskId": { "description": "The ID of the task this configuration is associated with.", "type": "string" }, "token": { "description": "A token unique for this task or session.", "type": "string" }, "url": { "description": "Required. The URL where the notification should be sent.", "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" }, "id": { "description": "The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.", "type": "string" }, "authentication": { "description": "Authentication information required to send the notification.", "$ref": "LfA2aV1AuthenticationInfo" } } }, "RunSessionRequest": { "description": "Request message for SessionService.RunSession.", "type": "object", "id": "RunSessionRequest", "properties": { "config": { "description": "Required. The configuration for the session.", "$ref": "SessionConfig" }, "inputs": { "description": "Required. Inputs for the session.", "type": "array", "items": { "$ref": "SessionInput" } } } }, "GenerateAppResourceResponseTools": { "description": "The list of tools generated by the LLM assistant.", "type": "object", "id": "GenerateAppResourceResponseTools", "properties": { "tools": { "description": "The list of tools generated by the LLM assistant.", "type": "array", "items": { "$ref": "Tool" } } } }, "ToolResponse": { "properties": { "id": { "description": "Optional. The matching ID of the tool call the response is for.", "type": "string" }, "toolsetTool": { "description": "Optional. The toolset tool that got executed.", "$ref": "ToolsetTool" }, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "response": { "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", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "displayName": { "description": "Output only. Display name of the tool.", "type": "string", "readOnly": true } }, "id": "ToolResponse", "description": "The execution result of a specific tool from the client or the agent.", "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": { "prompt": { "description": "Required. Policy prompt.", "type": "string" }, "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" }, "maxConversationMessages": { "format": "int32", "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" }, "modelSettings": { "description": "Optional. Model settings.", "$ref": "ModelSettings" }, "policyScope": { "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." ], "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" ] }, "failOpen": { "description": "Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.", "type": "boolean" } } }, "ExportAppRequest": { "properties": { "exportFormat": { "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "description": "Required. The format to export the app in.", "type": "string", "enumDescriptions": [ "The export format is unspecified.", "The export format is JSON.", "The export format is YAML." ] }, "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" }, "appVersion": { "description": "Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`.", "type": "string" } }, "description": "Request message for AgentService.ExportApp.", "type": "object", "id": "ExportAppRequest" }, "GenerateAppResourceResponseEvaluations": { "description": "The list of evaluations generated by the LLM assistant.", "type": "object", "id": "GenerateAppResourceResponseEvaluations", "properties": { "evaluations": { "description": "The list of generated evaluations.", "type": "array", "items": { "$ref": "Evaluation" } } } }, "EvaluationResultEvaluationExpectationResult": { "properties": { "explanation": { "description": "Output only. The explanation for the result.", "type": "string", "readOnly": true }, "evaluationExpectation": { "description": "Output only. The evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`", "type": "string", "readOnly": true }, "prompt": { "description": "Output only. The prompt that was used for the evaluation.", "type": "string", "readOnly": true }, "outcome": { "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "description": "Output only. The outcome of the evaluation expectation.", "type": "string", "readOnly": true, "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ] } }, "description": "The result of a single evaluation expectation.", "type": "object", "id": "EvaluationResultEvaluationExpectationResult" }, "AgentTool": { "properties": { "description": { "description": "Optional. Description of the tool's purpose.", "type": "string" }, "name": { "description": "Required. The name of the agent tool.", "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" } }, "description": "Represents a tool that allows the agent to call another agent.", "type": "object", "id": "AgentTool" }, "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" }, "EvaluationRunProgress": { "properties": { "totalCount": { "readOnly": true, "description": "Output only. Total number of evaluation results in this run.", "type": "integer", "format": "int32" }, "errorCount": { "format": "int32", "readOnly": true, "description": "Output only. Number of evaluation results that failed to execute. (EvaluationResult.execution_state is ERROR).", "type": "integer" }, "passedCount": { "format": "int32", "description": "Output only. Number of completed evaluation results with an outcome of PASS. (EvaluationResult.execution_state is COMPLETED and EvaluationResult.evaluation_status is PASS).", "type": "integer", "readOnly": true }, "cancelledCount": { "readOnly": true, "description": "Output only. Number of evaluation results that were cancelled. (EvaluationResult.execution_state is CANCELLED).", "type": "integer", "format": "int32" }, "completedCount": { "format": "int32", "readOnly": true, "description": "Output only. Number of evaluation results that finished successfully. (EvaluationResult.execution_state is COMPLETED).", "type": "integer" }, "failedCount": { "format": "int32", "readOnly": true, "description": "Output only. Number of completed evaluation results with an outcome of FAIL. (EvaluationResult.execution_state is COMPLETED and EvaluationResult.evaluation_status is FAIL).", "type": "integer" } }, "description": "The progress of the evaluation run.", "type": "object", "id": "EvaluationRunProgress" }, "ListScheduledEvaluationRunsResponse": { "description": "Response message for EvaluationService.ListScheduledEvaluationRuns.", "type": "object", "id": "ListScheduledEvaluationRunsResponse", "properties": { "scheduledEvaluationRuns": { "description": "The list of scheduled evaluation runs.", "type": "array", "items": { "$ref": "ScheduledEvaluationRun" } }, "nextPageToken": { "description": "A token that can be sent as ListScheduledEvaluationRunsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } } }, "UploadEvaluationAudioRequest": { "properties": { "audioContent": { "description": "Required. The raw audio bytes. The format of the audio must be single-channel LINEAR16 with a sample rate of 16kHz (default InputAudioConfig).", "type": "string", "format": "byte" }, "previousAudioGcsUri": { "description": "Optional. The Google Cloud Storage URI of the previously uploaded audio file to be deleted. Format: `gs:///`", "type": "string" } }, "id": "UploadEvaluationAudioRequest", "description": "Request message for EvaluationService.UploadEvaluationAudio.", "type": "object" }, "RedactionConfig": { "properties": { "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" }, "enableRedaction": { "description": "Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.", "type": "boolean" }, "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" } }, "id": "RedactionConfig", "description": "Configuration to instruct how sensitive data should be handled.", "type": "object" }, "EvaluationPersonaSpeechConfig": { "description": "Configuration for Text-to-Speech generation.", "type": "object", "id": "EvaluationPersonaSpeechConfig", "properties": { "environment": { "description": "Optional. The simulated audio environment.", "type": "string", "enumDescriptions": [ "Background environment unspecified.", "Call center environment.", "Traffic noise environment.", "Kids noise environment.", "Cafe environment." ], "enum": [ "BACKGROUND_ENVIRONMENT_UNSPECIFIED", "CALL_CENTER", "TRAFFIC", "KIDS_NOISE", "CAFE" ] }, "speakingRate": { "format": "double", "description": "Optional. The speaking rate. 1.0 is normal. Lower is slower (e.g., 0.8), higher is faster (e.g., 1.5). Useful for testing how the agent handles fast talkers.", "type": "number" }, "voiceId": { "description": "Optional. The specific voice identifier/accent to use. Example: \"en-US-Wavenet-D\" or \"en-GB-Standard-A\"", "type": "string" } } }, "ToolsetTool": { "description": "A tool that is created from a toolset.", "type": "object", "id": "ToolsetTool", "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" } } }, "AgentLlmAgent": { "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", "properties": {} }, "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" } } }, "GenerateEvaluationRequest": { "id": "GenerateEvaluationRequest", "description": "Request message for EvaluationService.GenerateEvaluation.", "type": "object", "properties": { "source": { "deprecated": true, "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "description": "Optional. Indicate the source of the conversation. If not set, all sources will be searched.", "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." ] }, "evaluationType": { "enumDescriptions": [ "Unspecified type. Defaults to GOLDEN.", "Golden evaluation.", "Scenario evaluation." ], "description": "Optional. The type of evaluation to generate. Defaults to GOLDEN if unspecified.", "type": "string", "enum": [ "EVALUATION_TYPE_UNSPECIFIED", "GOLDEN", "SCENARIO" ] } } }, "AudioRecordingConfig": { "properties": { "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" }, "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" } }, "id": "AudioRecordingConfig", "description": "Configuration for how the audio interactions should be recorded.", "type": "object" }, "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", "id": "MockedToolCall", "properties": { "mockResponse": { "description": "Optional. The mock response / output to return if the tool call args / inputs match the pattern.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "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." } }, "toolId": { "description": "Optional. The name of the tool to mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "toolset": { "description": "Optional. The toolset to mock.", "$ref": "ToolsetTool" }, "tool": { "description": "Optional. Deprecated. Use tool_identifier instead.", "type": "string", "deprecated": true } } }, "OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "type": "object", "id": "OperationMetadata", "properties": { "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "requestedCancellation": { "readOnly": true, "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`.", "type": "boolean" }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "statusMessage": { "readOnly": true, "description": "Output only. Human-readable status of the operation, if any.", "type": "string" } } }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" } } }, "Status": { "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", "properties": { "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" }, "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "details": { "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array" } } }, "ListGuardrailsResponse": { "id": "ListGuardrailsResponse", "description": "Response message for AgentService.ListGuardrails.", "type": "object", "properties": { "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" }, "guardrails": { "description": "The list of guardrails.", "type": "array", "items": { "$ref": "Guardrail" } } } }, "LfA2aV1AgentCardSignature": { "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", "properties": { "header": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The unprotected JWS header values.", "type": "object" }, "signature": { "description": "Required. The computed signature, base64url-encoded.", "type": "string" }, "protected": { "description": "Required. Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object.", "type": "string" } } }, "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", "id": "McpToolOverride", "properties": { "tool": { "description": "Required. The original name of the tool as it is emitted by the MCP server.", "type": "string" }, "descriptionOverride": { "description": "Optional. If present, this tool uses this description instead of the original description from the 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.", "$ref": "McpToolDefinition", "readOnly": true } } }, "LfA2aV1Artifact": { "properties": { "parts": { "description": "Required. The content of the artifact. Must contain at least one part.", "type": "array", "items": { "$ref": "LfA2aV1Part" } }, "extensions": { "description": "The URIs of extensions that are present or contributed to this Artifact.", "type": "array", "items": { "type": "string" } }, "name": { "description": "A human readable name for the artifact.", "type": "string" }, "artifactId": { "description": "Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.", "type": "string" }, "description": { "description": "Optional. A human readable description of the artifact.", "type": "string" }, "metadata": { "description": "Optional. Metadata included with the artifact.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "description": "Artifacts represent task outputs.", "type": "object", "id": "LfA2aV1Artifact" }, "LfA2aV1ImplicitOAuthFlow": { "description": "Deprecated: Use Authorization Code + PKCE instead.", "type": "object", "id": "LfA2aV1ImplicitOAuthFlow", "properties": { "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" }, "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" } } }, "EndUserAuthConfigOauth2JwtBearerConfig": { "properties": { "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" }, "subject": { "description": "Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" } }, "description": "JWT Profile Oauth 2.0 Authorization Grant authentication configuration.", "type": "object", "id": "EndUserAuthConfigOauth2JwtBearerConfig" }, "ExperimentConfig": { "id": "ExperimentConfig", "description": "Experiment for the deployment.", "type": "object", "properties": { "versionRelease": { "description": "Optional. Version release for the experiment.", "$ref": "ExperimentConfigVersionRelease" } } }, "EvaluationResultScenarioResult": { "properties": { "spanLatencies": { "description": "Output only. The latency of spans in the conversation.", "type": "array", "readOnly": true, "items": { "$ref": "EvaluationResultSpanLatency" } }, "taskCompleted": { "description": "Output only. Whether the task was completed for this turn. This is a composite of all expectations satisfied, no hallucinations, and user goal satisfaction.", "type": "boolean", "readOnly": true }, "evaluationExpectationResults": { "items": { "$ref": "EvaluationResultEvaluationExpectationResult" }, "description": "Output only. The results of the evaluation expectations.", "type": "array", "readOnly": true }, "toolCallLatencies": { "readOnly": true, "description": "Output only. The latency of each tool call execution in the conversation.", "type": "array", "items": { "$ref": "EvaluationResultToolCallLatency" } }, "taskCompletionResult": { "deprecated": true, "description": "Output only. The result of the task completion check.", "$ref": "EvaluationResultTaskCompletionResult", "readOnly": true }, "task": { "description": "Output only. The task that was used when running the scenario for this result.", "type": "string", "readOnly": true }, "expectationOutcomes": { "description": "Output only. The outcome of each expectation.", "type": "array", "readOnly": true, "items": { "$ref": "EvaluationResultScenarioExpectationOutcome" } }, "conversation": { "description": "Output only. The conversation that was generated in the scenario.", "type": "string", "readOnly": true }, "userFacts": { "readOnly": true, "description": "Output only. The user facts that were used by the scenario for this result.", "type": "array", "items": { "$ref": "EvaluationScenarioUserFact" } }, "rubricOutcomes": { "description": "Output only. The outcome of the rubric.", "type": "array", "readOnly": true, "items": { "$ref": "EvaluationResultScenarioRubricOutcome" } }, "hallucinationResult": { "items": { "$ref": "EvaluationResultHallucinationResult" }, "description": "Output only. The result of the hallucination check. There will be one hallucination result for each turn in the conversation.", "type": "array", "readOnly": true }, "userGoalSatisfactionResult": { "description": "Output only. The result of the user goal satisfaction check.", "$ref": "EvaluationResultUserGoalSatisfactionResult", "readOnly": true }, "allExpectationsSatisfied": { "description": "Output only. Whether all expectations were satisfied for this turn.", "type": "boolean", "readOnly": true } }, "id": "EvaluationResultScenarioResult", "description": "The outcome of a scenario evaluation.", "type": "object" }, "EvaluationMetricsConfig": { "id": "EvaluationMetricsConfig", "description": "Configures the metrics for an evaluation.", "type": "object", "properties": { "goldenMetricsConfig": { "description": "Optional. Configuration for the golden metrics for the evaluation.", "$ref": "EvaluationMetricsConfigGoldenMetricsConfig" }, "scenarioMetricsConfig": { "description": "Optional. Configuration for the scenario metrics for the evaluation.", "$ref": "EvaluationMetricsConfigScenarioMetricsConfig" } } }, "EvaluationResultSemanticSimilarityResult": { "properties": { "outcome": { "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "description": "Output only. The outcome of the semantic similarity check. This is determined by comparing the score to the semantic_similarity_success_threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.", "type": "string", "readOnly": true, "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ] }, "label": { "readOnly": true, "description": "Output only. The label associated with each score. Score 4: Fully Consistent Score 3: Mostly Consistent Score 2: Partially Consistent (Minor Omissions) Score 1: Largely Inconsistent (Major Omissions) Score 0: Completely Inconsistent / Contradictory", "type": "string" }, "score": { "format": "int32", "description": "Output only. The semantic similarity score. Can be 0, 1, 2, 3, or 4.", "type": "integer", "readOnly": true }, "explanation": { "readOnly": true, "description": "Output only. The explanation for the semantic similarity score.", "type": "string" } }, "description": "The result of the semantic similarity check.", "type": "object", "id": "EvaluationResultSemanticSimilarityResult" }, "RemoteAgentTool": { "properties": { "name": { "description": "Required. The name of the tool.", "type": "string" }, "description": { "description": "Required. The description of the tool.", "type": "string" }, "agentCard": { "description": "Required. The agent card of the remote agent that this tool invokes.", "$ref": "AgentCard" } }, "description": "Represents a tool that allows the agent to call another remote agent.", "type": "object", "id": "RemoteAgentTool" }, "GuardrailCodeCallback": { "id": "GuardrailCodeCallback", "description": "Guardrail that blocks the conversation based on the code callbacks provided.", "type": "object", "properties": { "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" }, "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" }, "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" } } }, "LfA2aV1TaskStatus": { "properties": { "state": { "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." ], "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" ] }, "timestamp": { "description": "ISO 8601 Timestamp when the status was recorded. Example: \"2023-10-27T10:00:00Z\"", "type": "string", "format": "google-datetime" }, "message": { "description": "A message associated with the status.", "$ref": "LfA2aV1Message" } }, "id": "LfA2aV1TaskStatus", "description": "A container for the status of a task", "type": "object" }, "GuardrailModelSafety": { "properties": { "safetySettings": { "description": "Required. List of safety settings.", "type": "array", "items": { "$ref": "GuardrailModelSafetySafetySetting" } } }, "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" }, "ConnectorTool": { "properties": { "action": { "description": "Required. Action for the tool to use.", "$ref": "Action" }, "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" }, "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": "A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview.", "type": "object", "id": "ConnectorTool" }, "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", "id": "ClientFunction", "properties": { "response": { "description": "Optional. The schema of the function response.", "$ref": "Schema" }, "name": { "description": "Required. The function name.", "type": "string" }, "parameters": { "description": "Optional. The schema of the function parameters.", "$ref": "Schema" }, "description": { "description": "Optional. The function description.", "type": "string" } } }, "AppVersion": { "properties": { "snapshot": { "description": "Output only. The snapshot of the app when the version is created.", "$ref": "AppSnapshot", "readOnly": true }, "name": { "description": "Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "creator": { "readOnly": true, "description": "Output only. Email of the user who created the app version.", "type": "string" }, "description": { "description": "Optional. The description of the app version.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. Timestamp when the app version was created.", "type": "string", "format": "google-datetime" }, "displayName": { "description": "Optional. The display name of the app version.", "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.", "type": "string", "readOnly": true } }, "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", "id": "AppVersion" }, "DataStoreToolEngineSource": { "id": "DataStoreToolEngineSource", "description": "Configuration for searching within an Engine, potentially targeting specific DataStores.", "type": "object", "properties": { "dataStoreSources": { "description": "Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.", "type": "array", "items": { "$ref": "DataStoreToolDataStoreSource" } }, "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" } } }, "ModelSettings": { "id": "ModelSettings", "description": "Model settings contains various configurations for the LLM model.", "type": "object", "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" } } }, "SecuritySettings": { "properties": { "name": { "description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`", "type": "string" }, "endpointControlPolicy": { "description": "Optional. Endpoint control related settings.", "$ref": "EndpointControlPolicy" }, "etag": { "description": "Output only. Etag of the security settings.", "type": "string", "readOnly": true }, "createTime": { "readOnly": true, "description": "Output only. Create time of the security settings.", "type": "string", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "description": "Output only. Last update time of the security settings.", "type": "string", "readOnly": true } }, "description": "Project/Location level security settings for CES.", "type": "object", "id": "SecuritySettings" }, "ToolResponses": { "properties": { "toolResponses": { "items": { "$ref": "ToolResponse" }, "description": "Optional. The list of tool execution results.", "type": "array" } }, "description": "Execution results for the requested tool calls from the client.", "type": "object", "id": "ToolResponses" }, "DataStoreToolBoostSpecConditionBoostSpec": { "id": "DataStoreToolBoostSpecConditionBoostSpec", "description": "Boost specification for a condition.", "type": "object", "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": { "format": "float", "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" }, "boostControlSpec": { "description": "Optional. Complex specification for custom ranking based on customer defined attribute value.", "$ref": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec" } } }, "EvaluationResultHallucinationResult": { "description": "The result of the hallucination check for a single turn.", "type": "object", "id": "EvaluationResultHallucinationResult", "properties": { "label": { "readOnly": true, "description": "Output only. The label associated with each score. Score 1: Justified Score 0: Not Justified Score -1: No Claim To Assess", "type": "string" }, "score": { "format": "int32", "readOnly": true, "description": "Output only. The hallucination score. Can be -1, 0, 1.", "type": "integer" }, "explanation": { "readOnly": true, "description": "Output only. The explanation for the hallucination score.", "type": "string" } } }, "GenerateAppResourceRequestHillClimbingFixConfig": { "id": "GenerateAppResourceRequestHillClimbingFixConfig", "description": "The configuration to be used for hill climbing fixes.", "type": "object", "properties": { "qualityReport": { "description": "Required. The quality report used to inform the instruction following fix.", "$ref": "QualityReport" } } }, "EvaluationResultUserGoalSatisfactionResult": { "id": "EvaluationResultUserGoalSatisfactionResult", "description": "The result of a user goal satisfaction check for a conversation.", "type": "object", "properties": { "label": { "description": "Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified", "type": "string", "readOnly": true }, "score": { "description": "Output only. The user task satisfaction score. Can be -1, 0, 1, 2.", "type": "integer", "readOnly": true, "format": "int32" }, "explanation": { "description": "Output only. The explanation for the user task satisfaction score.", "type": "string", "readOnly": true } } }, "RetrieveToolSchemaResponse": { "id": "RetrieveToolSchemaResponse", "description": "Response message for ToolService.RetrieveToolSchema.", "type": "object", "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" }, "inputSchema": { "description": "The schema of the tool input parameters.", "$ref": "Schema" }, "toolsetTool": { "description": "The toolset tool that the schema is for.", "$ref": "ToolsetTool" } } }, "AppVariableDeclaration": { "description": "Defines the structure and metadata for a variable.", "type": "object", "id": "AppVariableDeclaration", "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" } } }, "LfA2aV1Task": { "properties": { "status": { "description": "Required. The current status of a `Task`, including `state` and a `message`.", "$ref": "LfA2aV1TaskStatus" }, "metadata": { "description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "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" }, "artifacts": { "items": { "$ref": "LfA2aV1Artifact" }, "description": "A set of output artifacts for a `Task`.", "type": "array" }, "history": { "items": { "$ref": "LfA2aV1Message" }, "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from 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" }, "ApiAuthentication": { "properties": { "serviceAgentIdTokenAuthConfig": { "description": "Optional. Config for ID token auth generated from CES service agent.", "$ref": "ServiceAgentIdTokenAuthConfig" }, "oauthConfig": { "description": "Optional. Config for OAuth.", "$ref": "OAuthConfig" }, "bearerTokenConfig": { "description": "Optional. Config for bearer token auth.", "$ref": "BearerTokenConfig" }, "serviceAccountAuthConfig": { "description": "Optional. Config for service account authentication.", "$ref": "ServiceAccountAuthConfig" }, "apiKeyConfig": { "description": "Optional. Config for API key auth.", "$ref": "ApiKeyConfig" } }, "id": "ApiAuthentication", "description": "Authentication information required for API calls.", "type": "object" }, "Blob": { "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" }, "data": { "format": "byte", "description": "Required. Raw bytes of the blob.", "type": "string" } }, "description": "Represents a blob input or output in the conversation.", "type": "object", "id": "Blob" }, "TransferRuleDeterministicTransfer": { "properties": { "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" }, "expressionCondition": { "description": "Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs.", "$ref": "ExpressionCondition" } }, "description": "Deterministic transfer rule. When the condition evaluates to true, the transfer occurs.", "type": "object", "id": "TransferRuleDeterministicTransfer" }, "WidgetToolDataMapping": { "id": "WidgetToolDataMapping", "description": "Configuration for mapping data from a source tool to the widget's input parameters.", "type": "object", "properties": { "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" }, "fieldMappings": { "description": "Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.", "type": "object", "additionalProperties": { "type": "string" } }, "mode": { "enumDescriptions": [ "Unspecified mode.", "Use the `field_mappings` map for data transformation.", "Use the `python_script` for data transformation." ], "description": "Optional. The mode of the data mapping.", "type": "string", "enum": [ "MODE_UNSPECIFIED", "FIELD_MAPPING", "PYTHON_SCRIPT" ] }, "pythonFunction": { "description": "Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.", "$ref": "PythonFunction" }, "pythonScript": { "deprecated": true, "description": "Deprecated: Use `python_function` instead.", "type": "string" } } }, "ListAppVersionsResponse": { "id": "ListAppVersionsResponse", "description": "Response message for AgentService.ListAppVersions.", "type": "object", "properties": { "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" }, "appVersions": { "description": "The list of app versions.", "type": "array", "items": { "$ref": "AppVersion" } } } }, "GenerateAppResourceRequestRefineInstructions": { "properties": { "instructions": { "description": "Required. The instructions to refine the resource.", "type": "string" }, "startIndex": { "description": "Required. The first character (inclusive) of the text to refine.", "type": "string", "format": "int64" }, "endIndex": { "format": "int64", "description": "Required. The last character (inclusive) of the text to refine.", "type": "string" }, "fieldMask": { "description": "Required. The field of the resource being refined. Only one field is allowed per RefineInstructions. If refining agent instructions, the field mask should be \"instructions\".", "type": "string", "format": "google-fieldmask" } }, "id": "GenerateAppResourceRequestRefineInstructions", "description": "The instructions to be used to refine a part of the resource. The part of the resource can be specified with a start index, end index and a field mask. For example, if you want to refine a part of the agent instructions you can specify the index of the first character of the instructions, the index of the last character of the instructions and the field mask as \"instructions\".", "type": "object" }, "DataStoreToolBoostSpecs": { "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" } }, "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" }, "AudioProcessingConfig": { "properties": { "synthesizeSpeechConfigs": { "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", "additionalProperties": { "$ref": "SynthesizeSpeechConfig" } }, "bargeInConfig": { "description": "Optional. Configures the agent behavior for the user barge-in activities.", "$ref": "BargeInConfig" }, "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" }, "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" } }, "id": "AudioProcessingConfig", "description": "Configuration for how the input and output audio should be processed and delivered.", "type": "object" }, "McpToolset": { "id": "McpToolset", "description": "A toolset that contains a list of tools that are offered by the MCP server.", "type": "object", "properties": { "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" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.", "$ref": "ServiceDirectoryConfig" }, "toolOverrides": { "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", "items": { "$ref": "McpToolOverride" } }, "customHeaders": { "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", "additionalProperties": { "type": "string" } }, "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" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust.", "$ref": "TlsConfig" } } }, "EndpointControlPolicy": { "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": { "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", "items": { "type": "string" } } }, "description": "Defines project/location level endpoint control policy.", "type": "object", "id": "EndpointControlPolicy" }, "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": { "description": { "description": "Optional. Human-readable description of the agent.", "type": "string" }, "modelSettings": { "description": "Optional. Configurations for the LLM model.", "$ref": "ModelSettings" }, "validationErrors": { "readOnly": true, "description": "Output only. Misconfigurations or errors in the agent that may affect agent quality.", "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.", "type": "string", "readOnly": true }, "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" }, "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" } }, "name": { "description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{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" }, "tools": { "items": { "type": "string" }, "description": "Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "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" }, "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" } }, "llmAgent": { "description": "Optional. The default agent type.", "$ref": "AgentLlmAgent" }, "toolsets": { "items": { "$ref": "AgentAgentToolset" }, "description": "Optional. List of toolsets for the agent.", "type": "array" }, "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" }, "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" }, "instruction": { "description": "Optional. Instructions for the LLM model to guide the agent's behavior.", "type": "string" }, "transferRules": { "description": "Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.", "type": "array", "items": { "$ref": "TransferRule" } }, "guardrails": { "items": { "type": "string" }, "description": "Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "type": "array" }, "createTime": { "readOnly": true, "description": "Output only. Timestamp when the agent was created.", "type": "string", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the agent was last updated.", "type": "string" }, "displayName": { "description": "Required. Display name of the agent.", "type": "string" }, "afterModelCallbacks": { "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", "items": { "$ref": "Callback" } }, "beforeModelCallbacks": { "items": { "$ref": "Callback" }, "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" } } }, "EndUserAuthConfigOauth2AuthCodeConfig": { "description": "Oauth 2.0 Authorization Code authentication configuration.", "type": "object", "id": "EndUserAuthConfigOauth2AuthCodeConfig", "properties": { "oauthToken": { "description": "Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" } } }, "EvaluationMetricsThresholdsToolMatchingSettings": { "properties": { "extraToolCallBehavior": { "enum": [ "EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED", "FAIL", "ALLOW" ], "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" } }, "id": "EvaluationMetricsThresholdsToolMatchingSettings", "description": "Settings for matching tool calls.", "type": "object" }, "EvaluationMetricsConfigGoldenMetricsConfig": { "properties": { "stepToolCorrectnessMetricsConfig": { "description": "Optional. Configuration for step level tool correctness metrics.", "$ref": "EvaluationMetricsConfigToolCorrectnessMetricsConfig" }, "toolCorrectnessMetricsConfig": { "description": "Optional. Configuration for turn level tool correctness metrics.", "$ref": "EvaluationMetricsConfigToolCorrectnessMetricsConfig" }, "semanticSimilarityMetricsConfig": { "description": "Optional. Global configuration for semantic similarity metrics.", "$ref": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig" } }, "description": "Configuration for the golden metrics for the evaluation.", "type": "object", "id": "EvaluationMetricsConfigGoldenMetricsConfig" }, "Example": { "properties": { "description": { "description": "Optional. Human-readable description of the example.", "type": "string" }, "invalid": { "readOnly": true, "description": "Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.", "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 example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`", "type": "string" }, "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" }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when the example was created.", "type": "string", "readOnly": true }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when the example was last updated.", "type": "string", "readOnly": true }, "displayName": { "description": "Required. Display name of the example.", "type": "string" }, "messages": { "description": "Optional. The collection of messages that make up the conversation.", "type": "array", "items": { "$ref": "Message" } } }, "description": "An example represents a sample conversation between the user and the agent(s).", "type": "object", "id": "Example" }, "EvaluationStep": { "properties": { "userInput": { "description": "Optional. User input for the conversation.", "$ref": "SessionInput" }, "agentTransfer": { "description": "Optional. Transfer the conversation to a different agent.", "$ref": "AgentTransfer" }, "expectation": { "description": "Optional. Executes an expectation on the current turn.", "$ref": "EvaluationGoldenExpectation" } }, "id": "EvaluationStep", "description": "A step defines a singular action to happen during the evaluation.", "type": "object" }, "EvaluationExpectation": { "description": "An evaluation expectation represents a specific criteria to evaluate against.", "type": "object", "id": "EvaluationExpectation", "properties": { "name": { "description": "Identifier. The unique identifier of this evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`", "type": "string" }, "llmCriteria": { "description": "Optional. Evaluation criteria based on an LLM prompt.", "$ref": "EvaluationExpectationLlmCriteria" }, "displayName": { "description": "Required. User-defined display name. Must be unique within the app.", "type": "string" }, "etag": { "readOnly": true, "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.", "type": "string" }, "tags": { "items": { "type": "string" }, "description": "Optional. User-defined tags for expectations. Can be used to filter expectations.", "type": "array" }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when the evaluation expectation was created.", "type": "string", "readOnly": true }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the evaluation expectation was last updated.", "type": "string" } } }, "ToolCalls": { "description": "Request for the client to execute the tools and return the execution results before continuing the session.", "type": "object", "id": "ToolCalls", "properties": { "toolCalls": { "description": "Optional. The list of tool calls to execute.", "type": "array", "items": { "$ref": "ToolCall" } } } }, "ImportEvaluationsRequest": { "properties": { "csvContent": { "description": "Raw bytes representing the csv file with the evaluations structure.", "type": "string", "format": "byte" }, "importOptions": { "description": "Optional. Options governing the import process for the evaluations.", "$ref": "ImportEvaluationsRequestImportOptions" }, "conversationList": { "description": "The conversations to import the evaluations from.", "$ref": "ImportEvaluationsRequestConversationList" }, "gcsUri": { "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI from which to import evaluations. The format of this URI must be `gs:///`.", "type": "string" } }, "description": "Request message for EvaluationService.ImportEvaluations.", "type": "object", "id": "ImportEvaluationsRequest" }, "TriggerActionTransferAgent": { "description": "The agent will transfer the conversation to a different agent.", "type": "object", "id": "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" } } } }, "mtlsRootUrl": "https://ces.mtls.googleapis.com/", "title": "Gemini Enterprise for Customer Experience API", "rootUrl": "https://ces.googleapis.com/", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "$.xgafv": { "location": "query", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "description": "V1 error format." }, "prettyPrint": { "default": "true", "location": "query", "type": "boolean", "description": "Returns response with indentations and line breaks." }, "alt": { "location": "query", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string", "description": "Data format for response.", "default": "json" }, "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." }, "quotaUser": { "location": "query", "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." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" } }, "id": "ces:v1beta", "name": "ces", "description": "" }