{ "fullyEncodeReservedExpansion": true, "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "rootUrl": "https://ces.googleapis.com/", "resources": { "projects": { "resources": { "locations": { "methods": { "getSecuritySettings": { "id": "ces.projects.locations.getSecuritySettings", "path": "v1beta/{+name}", "parameters": { "name": { "description": "Required. The resource name of the security settings to retrieve. Format: `projects/{project}/locations/{location}/securitySettings`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/securitySettings$" } }, "description": "Retrieves the security settings for the project and location.", "response": { "$ref": "SecuritySettings" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/securitySettings", "parameterOrder": [ "name" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations", "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "ces.projects.locations.list", "path": "v1beta/{+name}/locations", "parameters": { "pageToken": { "type": "string", "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." }, "name": { "type": "string", "location": "path", "description": "The resource that owns the locations collection, if applicable.", "required": true, "pattern": "^projects/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default." }, "extraLocationTypes": { "location": "query", "repeated": true, "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage." }, "filter": { "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", "location": "query" } }, "response": { "$ref": "ListLocationsResponse" }, "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." }, "updateSecuritySettings": { "path": "v1beta/{+name}", "parameters": { "updateMask": { "type": "string", "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." }, "name": { "type": "string", "location": "path", "description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/securitySettings$" } }, "response": { "$ref": "SecuritySettings" }, "description": "Updates the security settings for the project and location.", "id": "ces.projects.locations.updateSecuritySettings", "request": { "$ref": "SecuritySettings" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/securitySettings", "httpMethod": "PATCH" }, "get": { "path": "v1beta/{+name}", "parameters": { "name": { "type": "string", "location": "path", "description": "Resource name for the location.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "Location" }, "description": "Gets information about a location.", "id": "ces.projects.locations.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET" } }, "resources": { "apps": { "methods": { "generateAppResource": { "parameterOrder": [ "parent" ], "request": { "$ref": "GenerateAppResourceRequest" }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:generateAppResource", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Generates specific resources (e.g. agent) in the app using LLM assistant.", "response": { "$ref": "Operation" }, "path": "v1beta/{+parent}:generateAppResource", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the app to generate the resource for.", "required": true } }, "id": "ces.projects.locations.apps.generateAppResource" }, "list": { "id": "ces.projects.locations.apps.list", "description": "Lists apps in the given project and location.", "response": { "$ref": "ListAppsResponse" }, "path": "v1beta/{+parent}/apps", "parameters": { "parent": { "description": "Required. The resource name of the location to list apps from.", "required": true, "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.", "location": "query", "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" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListApps call.", "location": "query", "type": "string" }, "orderBy": { "type": "string", "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." } }, "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "importEvaluations": { "id": "ces.projects.locations.apps.importEvaluations", "response": { "$ref": "Operation" }, "description": "Imports evaluations into the app.", "path": "v1beta/{+parent}:importEvaluations", "parameters": { "parent": { "description": "Required. The app to import the evaluations into. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:importEvaluations", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "request": { "$ref": "ImportEvaluationsRequest" } }, "testPersonaVoice": { "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:testPersonaVoice", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "app" ], "request": { "$ref": "TestPersonaVoiceRequest" }, "id": "ces.projects.locations.apps.testPersonaVoice", "description": "Tests the voice of a persona. Also accepts a default persona.", "response": { "$ref": "TestPersonaVoiceResponse" }, "path": "v1beta/{+app}:testPersonaVoice", "parameters": { "app": { "location": "path", "type": "string", "description": "Required. the resource name of the app to test the persona voice for. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } } }, "retrieveToolSchema": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:retrieveToolSchema", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "request": { "$ref": "RetrieveToolSchemaRequest" }, "id": "ces.projects.locations.apps.retrieveToolSchema", "response": { "$ref": "RetrieveToolSchemaResponse" }, "description": "Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.", "path": "v1beta/{+parent}:retrieveToolSchema", "parameters": { "parent": { "description": "Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } } }, "delete": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "path": "v1beta/{+name}", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The resource name of the app to delete.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "etag": { "type": "string", "location": "query", "description": "Optional. The current etag of the app. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app, deletion will be blocked and an ABORTED error will be returned." } }, "description": "Deletes the specified app.", "response": { "$ref": "Operation" }, "id": "ces.projects.locations.apps.delete" }, "exportApp": { "id": "ces.projects.locations.apps.exportApp", "description": "Exports the specified app.", "response": { "$ref": "Operation" }, "path": "v1beta/{+name}:exportApp", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to export.", "required": true, "type": "string", "location": "path" } }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:exportApp", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "ExportAppRequest" } }, "executeTool": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:executeTool", "httpMethod": "POST", "request": { "$ref": "ExecuteToolRequest" }, "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.executeTool", "path": "v1beta/{+parent}:executeTool", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "response": { "$ref": "ExecuteToolResponse" }, "description": "Executes the given tool with the given arguments." }, "patch": { "httpMethod": "PATCH", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "App" }, "id": "ces.projects.locations.apps.patch", "description": "Updates the specified app.", "response": { "$ref": "App" }, "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "type": "string", "location": "path", "description": "Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true }, "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" } } }, "importApp": { "response": { "$ref": "Operation" }, "description": "Imports the specified app.", "path": "v1beta/{+parent}/apps:importApp", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The parent resource name with the location of the app to import.", "required": true } }, "id": "ces.projects.locations.apps.importApp", "parameterOrder": [ "parent" ], "request": { "$ref": "ImportAppRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps:importApp", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.get", "description": "Gets details of the specified app.", "response": { "$ref": "App" }, "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the app to retrieve.", "required": true } } }, "runEvaluation": { "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:runEvaluation", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "app" ], "request": { "$ref": "RunEvaluationRequest" }, "id": "ces.projects.locations.apps.runEvaluation", "description": "Runs an evaluation of the app.", "response": { "$ref": "Operation" }, "path": "v1beta/{+app}:runEvaluation", "parameters": { "app": { "description": "Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } } }, "create": { "request": { "$ref": "App" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps", "path": "v1beta/{+parent}/apps", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the location to create an app in.", "required": true }, "appId": { "description": "Optional. The ID to use for the app, which will become the final component of the app's resource name. If not provided, a unique ID will be automatically assigned for the app.", "location": "query", "type": "string" } }, "description": "Creates a new app in the given project and location.", "response": { "$ref": "Operation" }, "id": "ces.projects.locations.apps.create" } }, "resources": { "deployments": { "methods": { "patch": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "Deployment" }, "id": "ces.projects.locations.apps.deployments.patch", "response": { "$ref": "Deployment" }, "description": "Updates the specified deployment.", "path": "v1beta/{+name}", "parameters": { "updateMask": { "description": "Optional. The list of fields to update.", "location": "query", "format": "google-fieldmask", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "required": true, "type": "string", "location": "path" } } }, "delete": { "id": "ces.projects.locations.apps.deployments.delete", "description": "Deletes the specified deployment.", "response": { "$ref": "Empty" }, "path": "v1beta/{+name}", "parameters": { "name": { "description": "Required. The name of the deployment to delete. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$" }, "etag": { "type": "string", "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." } }, "httpMethod": "DELETE", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "create": { "path": "v1beta/{+parent}/deployments", "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.", "location": "query", "type": "string" }, "parent": { "description": "Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "description": "Creates a new deployment in the given app.", "response": { "$ref": "Deployment" }, "id": "ces.projects.locations.apps.deployments.create", "request": { "$ref": "Deployment" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments" }, "get": { "response": { "$ref": "Deployment" }, "description": "Gets details of the specified deployment.", "path": "v1beta/{+name}", "parameters": { "name": { "description": "Required. The name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$" } }, "id": "ces.projects.locations.apps.deployments.get", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.deployments.list", "description": "Lists deployments in the given app.", "response": { "$ref": "ListDeploymentsResponse" }, "path": "v1beta/{+parent}/deployments", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeployments` must match the call that provided the page token." }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" }, "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.", "location": "query", "format": "int32", "type": "integer" }, "parent": { "location": "path", "type": "string", "description": "Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } } } } }, "changelogs": { "methods": { "get": { "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/changelogs/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the changelog to retrieve.", "required": true } }, "description": "Gets the specified changelog.", "response": { "$ref": "Changelog" }, "id": "ces.projects.locations.apps.changelogs.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs/{changelogsId}" }, "list": { "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.changelogs.list", "description": "Lists the changelogs of the specified app.", "response": { "$ref": "ListChangelogsResponse" }, "path": "v1beta/{+parent}/changelogs", "parameters": { "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "parent": { "type": "string", "location": "path", "description": "Required. The resource name of the app to list changelogs from.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "filter": { "description": "Optional. Filter to be applied when listing the changelogs. See https://google.aip.dev/160 for more details. The filter string can be used to filter by `action`, `resource_type`, `resource_name`, `author`, and `create_time`. The `:` comparator can be used for case-insensitive partial matching on string fields, while `=` performs an exact case-sensitive match. Examples: * `action:update` (case-insensitive partial match) * `action=\"Create\"` (case-sensitive exact match) * `resource_type:agent` * `resource_name:my-agent` * `author:me@example.com` * `create_time \u003e \"2025-01-01T00:00:00Z\"` * `create_time \u003c= \"2025-01-01T00:00:00Z\" AND resource_type:tool`", "location": "query", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListChangelogs call." }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" } } } } }, "guardrails": { "methods": { "get": { "response": { "$ref": "Guardrail" }, "description": "Gets details of the specified guardrail.", "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the guardrail to retrieve.", "required": true } }, "id": "ces.projects.locations.apps.guardrails.get", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "description": "Creates a new guardrail in the given app.", "response": { "$ref": "Guardrail" }, "path": "v1beta/{+parent}/guardrails", "parameters": { "guardrailId": { "description": "Optional. The ID to use for the guardrail, which will become the final component of the guardrail's resource name. If not provided, a unique ID will be automatically assigned for the guardrail.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the app to create a guardrail in.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "id": "ces.projects.locations.apps.guardrails.create", "parameterOrder": [ "parent" ], "request": { "$ref": "Guardrail" }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1beta/{+parent}/guardrails", "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" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the app to list guardrails from.", "required": true }, "filter": { "description": "Optional. Filter to be applied when listing the guardrails. See https://google.aip.dev/160 for more details.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListGuardrails call." } }, "description": "Lists guardrails in the given app.", "response": { "$ref": "ListGuardrailsResponse" }, "id": "ces.projects.locations.apps.guardrails.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails" }, "patch": { "request": { "$ref": "Guardrail" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "httpMethod": "PATCH", "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "type": "string", "location": "path", "description": "Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "required": true }, "updateMask": { "location": "query", "format": "google-fieldmask", "type": "string", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated." } }, "response": { "$ref": "Guardrail" }, "description": "Updates the specified guardrail.", "id": "ces.projects.locations.apps.guardrails.patch" }, "delete": { "id": "ces.projects.locations.apps.guardrails.delete", "response": { "$ref": "Empty" }, "description": "Deletes the specified guardrail.", "path": "v1beta/{+name}", "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" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the guardrail to delete.", "required": true }, "etag": { "location": "query", "type": "string", "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." } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] } } }, "evaluationExpectations": { "methods": { "patch": { "description": "Updates an evaluation expectation.", "response": { "$ref": "EvaluationExpectation" }, "path": "v1beta/{+name}", "parameters": { "name": { "type": "string", "location": "path", "description": "Identifier. The unique identifier of this evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$" }, "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" } }, "id": "ces.projects.locations.apps.evaluationExpectations.patch", "parameterOrder": [ "name" ], "request": { "$ref": "EvaluationExpectation" }, "httpMethod": "PATCH", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "id": "ces.projects.locations.apps.evaluationExpectations.delete", "path": "v1beta/{+name}", "parameters": { "name": { "description": "Required. The resource name of the evaluation expectation to delete.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$" }, "etag": { "location": "query", "type": "string", "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." } }, "response": { "$ref": "Empty" }, "description": "Deletes an evaluation expectation.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ] }, "create": { "id": "ces.projects.locations.apps.evaluationExpectations.create", "description": "Creates an evaluation expectation.", "response": { "$ref": "EvaluationExpectation" }, "path": "v1beta/{+parent}/evaluationExpectations", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The app to create the evaluation expectation for. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "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" } }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "request": { "$ref": "EvaluationExpectation" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.evaluationExpectations.get", "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the evaluation expectation to retrieve.", "required": true } }, "response": { "$ref": "EvaluationExpectation" }, "description": "Gets details of the specified evaluation expectation." }, "list": { "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.evaluationExpectations.list", "description": "Lists all evaluation expectations in the given app.", "response": { "$ref": "ListEvaluationExpectationsResponse" }, "path": "v1beta/{+parent}/evaluationExpectations", "parameters": { "orderBy": { "location": "query", "type": "string", "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." }, "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the app to list evaluation expectations from.", "required": true, "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" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "format": "int32", "type": "integer" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationExpectations call.", "type": "string", "location": "query" } } } } }, "scheduledEvaluationRuns": { "methods": { "delete": { "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$", "description": "Required. The resource name of the scheduled evaluation run to delete.", "required": true, "location": "path", "type": "string" }, "etag": { "description": "Optional. The etag of the ScheduledEvaluationRun. If provided, it must match the server's etag.", "type": "string", "location": "query" } }, "response": { "$ref": "Empty" }, "description": "Deletes a scheduled evaluation run.", "id": "ces.projects.locations.apps.scheduledEvaluationRuns.delete", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}", "httpMethod": "DELETE" }, "patch": { "parameterOrder": [ "name" ], "request": { "$ref": "ScheduledEvaluationRun" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ScheduledEvaluationRun" }, "description": "Updates a scheduled evaluation run.", "path": "v1beta/{+name}", "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}", "required": true, "location": "path", "type": "string" }, "updateMask": { "type": "string", "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." } }, "id": "ces.projects.locations.apps.scheduledEvaluationRuns.patch" }, "list": { "id": "ces.projects.locations.apps.scheduledEvaluationRuns.list", "path": "v1beta/{+parent}/scheduledEvaluationRuns", "parameters": { "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" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListScheduledEvaluationRuns call.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "format": "int32", "type": "integer" }, "parent": { "description": "Required. The resource name of the app to list scheduled evaluation runs from.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "filter": { "type": "string", "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" } }, "description": "Lists all scheduled evaluation runs in the given app.", "response": { "$ref": "ListScheduledEvaluationRunsResponse" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns", "parameterOrder": [ "parent" ] }, "create": { "id": "ces.projects.locations.apps.scheduledEvaluationRuns.create", "path": "v1beta/{+parent}/scheduledEvaluationRuns", "parameters": { "scheduledEvaluationRunId": { "location": "query", "type": "string", "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." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The app to create the scheduled evaluation run for. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "location": "path", "type": "string" } }, "description": "Creates a scheduled evaluation run.", "response": { "$ref": "ScheduledEvaluationRun" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns", "request": { "$ref": "ScheduledEvaluationRun" }, "parameterOrder": [ "parent" ] }, "get": { "description": "Gets details of the specified scheduled evaluation run.", "response": { "$ref": "ScheduledEvaluationRun" }, "path": "v1beta/{+name}", "parameters": { "name": { "description": "Required. The resource name of the scheduled evaluation run to retrieve.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$" } }, "id": "ces.projects.locations.apps.scheduledEvaluationRuns.get", "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] } } }, "sessions": { "methods": { "generateChatToken": { "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:generateChatToken", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "GenerateChatTokenRequest" }, "id": "ces.projects.locations.apps.sessions.generateChatToken", "description": "Generates a session scoped token for chat widget to authenticate with Session APIs.", "response": { "$ref": "GenerateChatTokenResponse" }, "path": "v1beta/{+name}:generateChatToken", "parameters": { "name": { "description": "Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$" } } }, "runSession": { "description": "Initiates a single-turn interaction with the CES agent within a session.", "response": { "$ref": "RunSessionResponse" }, "path": "v1beta/{+session}:runSession", "parameters": { "session": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "type": "string", "location": "path", "description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`", "required": true } }, "id": "ces.projects.locations.apps.sessions.runSession", "parameterOrder": [ "session" ], "request": { "$ref": "RunSessionRequest" }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:runSession", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "streamRunSession": { "request": { "$ref": "RunSessionRequest" }, "parameterOrder": [ "session" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:streamRunSession", "httpMethod": "POST", "path": "v1beta/{+session}:streamRunSession", "parameters": { "session": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "type": "string", "location": "path", "description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`", "required": true } }, "response": { "$ref": "RunSessionResponse" }, "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.", "id": "ces.projects.locations.apps.sessions.streamRunSession" } } }, "agents": { "methods": { "delete": { "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" }, "description": "Deletes the specified agent.", "path": "v1beta/{+name}", "parameters": { "force": { "description": "Optional. Indicates whether to forcefully delete the agent, even if it is still referenced by other app/agents/examples. * If `force = false`, the deletion fails if other agents/examples reference it. * If `force = true`, delete the agent and remove it from all referencing apps/agents/examples.", "location": "query", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "description": "Required. The resource name of the agent to delete.", "required": true, "location": "path", "type": "string" }, "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.", "location": "query", "type": "string" } }, "id": "ces.projects.locations.apps.agents.delete" }, "patch": { "id": "ces.projects.locations.apps.agents.patch", "description": "Updates the specified agent.", "response": { "$ref": "Agent" }, "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "location": "path", "type": "string", "description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "required": true }, "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" } }, "httpMethod": "PATCH", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "Agent" } }, "list": { "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.agents.list", "description": "Lists agents in the given app.", "response": { "$ref": "ListAgentsResponse" }, "path": "v1beta/{+parent}/agents", "parameters": { "parent": { "type": "string", "location": "path", "description": "Required. The resource name of the app to list agents from.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details." }, "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": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListAgents call." }, "orderBy": { "type": "string", "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." } } }, "create": { "id": "ces.projects.locations.apps.agents.create", "path": "v1beta/{+parent}/agents", "parameters": { "agentId": { "location": "query", "type": "string", "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." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to create an agent in.", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "Agent" }, "description": "Creates a new agent in the given app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents", "httpMethod": "POST", "request": { "$ref": "Agent" }, "parameterOrder": [ "parent" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.agents.get", "path": "v1beta/{+name}", "parameters": { "name": { "description": "Required. The resource name of the agent to retrieve.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$" } }, "response": { "$ref": "Agent" }, "description": "Gets details of the specified agent." } } }, "evaluations": { "methods": { "delete": { "id": "ces.projects.locations.apps.evaluations.delete", "path": "v1beta/{+name}", "parameters": { "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.", "location": "query", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the evaluation to delete.", "required": true }, "etag": { "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.", "location": "query", "type": "string" } }, "response": { "$ref": "Empty" }, "description": "Deletes an evaluation.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ] }, "uploadEvaluationAudio": { "response": { "$ref": "UploadEvaluationAudioResponse" }, "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.", "path": "v1beta/{+name}:uploadEvaluationAudio", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "description": "Required. The resource name of the Evaluation for which to upload the evaluation audio. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "required": true, "location": "path", "type": "string" } }, "id": "ces.projects.locations.apps.evaluations.uploadEvaluationAudio", "parameterOrder": [ "name" ], "request": { "$ref": "UploadEvaluationAudioRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}:uploadEvaluationAudio", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "Evaluation" }, "id": "ces.projects.locations.apps.evaluations.patch", "response": { "$ref": "Evaluation" }, "description": "Updates an evaluation.", "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "type": "string", "location": "path", "description": "Identifier. The unique identifier of this evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "required": true }, "updateMask": { "type": "string", "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." } } }, "list": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.evaluations.list", "response": { "$ref": "ListEvaluationsResponse" }, "description": "Lists all evaluations in the given app.", "path": "v1beta/{+parent}/evaluations", "parameters": { "orderBy": { "location": "query", "type": "string", "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." }, "evaluationFilter": { "location": "query", "type": "string", "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" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "lastTenResults": { "type": "boolean", "location": "query", "description": "Optional. Whether to include the last 10 evaluation results for each evaluation in the response." }, "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the app to list evaluations from.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "filter": { "description": "Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.", "deprecated": true, "type": "string", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call." }, "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", "location": "query", "type": "string" } } }, "create": { "description": "Creates an evaluation.", "response": { "$ref": "Evaluation" }, "path": "v1beta/{+parent}/evaluations", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "location": "path", "type": "string" }, "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" } }, "id": "ces.projects.locations.apps.evaluations.create", "parameterOrder": [ "parent" ], "request": { "$ref": "Evaluation" }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "export": { "id": "ces.projects.locations.apps.evaluations.export", "response": { "$ref": "Operation" }, "description": "Exports evaluations.", "path": "v1beta/{+parent}/evaluations:export", "parameters": { "parent": { "type": "string", "location": "path", "description": "Required. The resource name of the app to export evaluations from. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations:export", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "request": { "$ref": "ExportEvaluationsRequest" } }, "get": { "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.evaluations.get", "description": "Gets details of the specified evaluation.", "response": { "$ref": "Evaluation" }, "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "description": "Required. The resource name of the evaluation to retrieve.", "required": true, "location": "path", "type": "string" } } } }, "resources": { "results": { "methods": { "export": { "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results:export", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "request": { "$ref": "ExportEvaluationResultsRequest" }, "id": "ces.projects.locations.apps.evaluations.results.export", "description": "Exports evaluations results.", "response": { "$ref": "Operation" }, "path": "v1beta/{+parent}/results:export", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the evaluation to export evaluation results from. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "required": true } } }, "get": { "id": "ces.projects.locations.apps.evaluations.results.get", "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$", "description": "Required. The resource name of the evaluation result to retrieve.", "required": true, "location": "path", "type": "string" } }, "response": { "$ref": "EvaluationResult" }, "description": "Gets details of the specified evaluation result.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "delete": { "id": "ces.projects.locations.apps.evaluations.results.delete", "description": "Deletes an evaluation result.", "response": { "$ref": "Empty" }, "path": "v1beta/{+name}", "parameters": { "name": { "description": "Required. The resource name of the evaluation result to delete.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$" } }, "httpMethod": "DELETE", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "list": { "parameterOrder": [ "parent" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all evaluation results for a given evaluation.", "response": { "$ref": "ListEvaluationResultsResponse" }, "path": "v1beta/{+parent}/results", "parameters": { "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "format": "int32", "type": "integer" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "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/-`", "required": true, "type": "string", "location": "path" }, "filter": { "description": "Optional. Filter to be applied when listing the evaluation results. See https://google.aip.dev/160 for more details.", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationResults call.", "type": "string", "location": "query" }, "orderBy": { "type": "string", "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." } }, "id": "ces.projects.locations.apps.evaluations.results.list" } } } } }, "evaluationRuns": { "methods": { "get": { "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationRuns/[^/]+$", "description": "Required. The resource name of the evaluation run to retrieve.", "required": true, "type": "string", "location": "path" } }, "description": "Gets details of the specified evaluation run.", "response": { "$ref": "EvaluationRun" }, "id": "ces.projects.locations.apps.evaluationRuns.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns/{evaluationRunsId}" }, "export": { "path": "v1beta/{+parent}/evaluationRuns:export", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the app to export evaluation runs from. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "response": { "$ref": "Operation" }, "description": "Exports evaluations runs.", "id": "ces.projects.locations.apps.evaluationRuns.export", "request": { "$ref": "ExportEvaluationRunsRequest" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns:export", "httpMethod": "POST" }, "delete": { "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationRuns/[^/]+$", "description": "Required. The resource name of the evaluation run to delete.", "required": true, "location": "path", "type": "string" } }, "response": { "$ref": "Operation" }, "description": "Deletes an evaluation run.", "id": "ces.projects.locations.apps.evaluationRuns.delete", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns/{evaluationRunsId}", "httpMethod": "DELETE" }, "list": { "response": { "$ref": "ListEvaluationRunsResponse" }, "description": "Lists all evaluation runs in the given app.", "path": "v1beta/{+parent}/evaluationRuns", "parameters": { "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "parent": { "description": "Required. The resource name of the app to list evaluation runs from.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter to be applied when listing the evaluation runs. See https://google.aip.dev/160 for more details." }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationRuns call.", "location": "query", "type": "string" }, "orderBy": { "location": "query", "type": "string", "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." } }, "id": "ces.projects.locations.apps.evaluationRuns.list", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] } } }, "conversations": { "methods": { "generateEvaluation": { "response": { "$ref": "Operation" }, "description": "Creates a golden evaluation from a conversation.", "path": "v1beta/{+conversation}:generateEvaluation", "parameters": { "conversation": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "description": "Required. The conversation to create the golden evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`", "required": true } }, "id": "ces.projects.locations.apps.conversations.generateEvaluation", "parameterOrder": [ "conversation" ], "request": { "$ref": "GenerateEvaluationRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}:generateEvaluation", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" }, "description": "Deletes the specified conversation.", "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the conversation to delete.", "required": true }, "source": { "type": "string", "location": "query", "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.", "deprecated": true, "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ] } }, "id": "ces.projects.locations.apps.conversations.delete" }, "get": { "path": "v1beta/{+name}", "parameters": { "source": { "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "type": "string", "location": "query", "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.", "deprecated": true }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$", "description": "Required. The resource name of the conversation to retrieve.", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "Conversation" }, "description": "Gets details of the specified conversation.", "id": "ces.projects.locations.apps.conversations.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}", "httpMethod": "GET" }, "batchDelete": { "id": "ces.projects.locations.apps.conversations.batchDelete", "path": "v1beta/{+parent}/conversations:batchDelete", "parameters": { "parent": { "type": "string", "location": "path", "description": "Required. The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "response": { "$ref": "Operation" }, "description": "Batch deletes the specified conversations.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations:batchDelete", "httpMethod": "POST", "request": { "$ref": "BatchDeleteConversationsRequest" }, "parameterOrder": [ "parent" ] }, "list": { "id": "ces.projects.locations.apps.conversations.list", "response": { "$ref": "ListConversationsResponse" }, "description": "Lists conversations in the given app.", "path": "v1beta/{+parent}/conversations", "parameters": { "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the app to list conversations from.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details." }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "sources": { "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "description": "Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default.", "repeated": true, "type": "string", "location": "query" }, "source": { "location": "query", "type": "string", "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.", "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" ] } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] } } }, "evaluationDatasets": { "methods": { "get": { "id": "ces.projects.locations.apps.evaluationDatasets.get", "path": "v1beta/{+name}", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The resource name of the evaluation dataset to retrieve.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$" } }, "response": { "$ref": "EvaluationDataset" }, "description": "Gets details of the specified evaluation dataset.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "create": { "parameterOrder": [ "parent" ], "request": { "$ref": "EvaluationDataset" }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an evaluation dataset.", "response": { "$ref": "EvaluationDataset" }, "path": "v1beta/{+parent}/evaluationDatasets", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "type": "string", "location": "path" }, "evaluationDatasetId": { "location": "query", "type": "string", "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." } }, "id": "ces.projects.locations.apps.evaluationDatasets.create" }, "list": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets", "httpMethod": "GET", "path": "v1beta/{+parent}/evaluationDatasets", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the app to list evaluation datasets from.", "required": true }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter to be applied when listing the evaluation datasets. See https://google.aip.dev/160 for more details." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationDatasets 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" } }, "response": { "$ref": "ListEvaluationDatasetsResponse" }, "description": "Lists all evaluation datasets in the given app.", "id": "ces.projects.locations.apps.evaluationDatasets.list" }, "patch": { "parameterOrder": [ "name" ], "request": { "$ref": "EvaluationDataset" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "EvaluationDataset" }, "description": "Updates an evaluation dataset.", "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$", "location": "path", "type": "string", "description": "Identifier. The unique identifier of this evaluation dataset. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "required": true }, "updateMask": { "type": "string", "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." } }, "id": "ces.projects.locations.apps.evaluationDatasets.patch" }, "delete": { "description": "Deletes an evaluation dataset.", "response": { "$ref": "Empty" }, "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the evaluation dataset to delete.", "required": true }, "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.", "location": "query", "type": "string" } }, "id": "ces.projects.locations.apps.evaluationDatasets.delete", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] } } }, "message": { "methods": { "send": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/message:send", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "tenant" ], "request": { "$ref": "LfA2aV1SendMessageRequest" }, "id": "ces.projects.locations.apps.message.send", "response": { "$ref": "LfA2aV1SendMessageResponse" }, "description": "Sends a message to an agent.", "path": "v1beta/{+tenant}/message:send", "parameters": { "tenant": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string", "description": "Optional. Tenant ID, provided as a path parameter.", "required": true } } } } }, "tools": { "methods": { "patch": { "id": "ces.projects.locations.apps.tools.patch", "description": "Updates the specified tool.", "response": { "$ref": "Tool" }, "path": "v1beta/{+name}", "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.", "required": true, "location": "path", "type": "string" }, "updateMask": { "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "location": "query", "format": "google-fieldmask", "type": "string" } }, "httpMethod": "PATCH", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "Tool" } }, "delete": { "id": "ces.projects.locations.apps.tools.delete", "path": "v1beta/{+name}", "parameters": { "force": { "location": "query", "type": "boolean", "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." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the tool to delete.", "required": true }, "etag": { "type": "string", "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." } }, "description": "Deletes the specified tool.", "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "parameterOrder": [ "name" ] }, "create": { "id": "ces.projects.locations.apps.tools.create", "description": "Creates a new tool in the given app.", "response": { "$ref": "Tool" }, "path": "v1beta/{+parent}/tools", "parameters": { "parent": { "description": "Required. The resource name of the app to create a tool in.", "required": true, "type": "string", "location": "path", "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" } }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "request": { "$ref": "Tool" } }, "get": { "path": "v1beta/{+name}", "parameters": { "name": { "description": "Required. The resource name of the tool to retrieve.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$" } }, "response": { "$ref": "Tool" }, "description": "Gets details of the specified tool.", "id": "ces.projects.locations.apps.tools.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "httpMethod": "GET" }, "list": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.tools.list", "path": "v1beta/{+parent}/tools", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListTools call." }, "parent": { "description": "Required. The resource name of the app to list tools from.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "filter": { "description": "Optional. Filter to be applied when listing the tools. Use \"include_system_tools=true\" to include system tools in the response. See https://google.aip.dev/160 for more details.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "format": "int32", "type": "integer" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details." } }, "description": "Lists tools in the given app.", "response": { "$ref": "ListToolsResponse" } } } }, "examples": { "methods": { "list": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples", "path": "v1beta/{+parent}/examples", "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.", "location": "query", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListExamples call." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to list examples from.", "required": true, "type": "string", "location": "path" }, "filter": { "description": "Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details.", "location": "query", "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" } }, "description": "Lists examples in the given app.", "response": { "$ref": "ListExamplesResponse" }, "id": "ces.projects.locations.apps.examples.list" }, "create": { "parameterOrder": [ "parent" ], "request": { "$ref": "Example" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Example" }, "description": "Creates a new example in the given app.", "path": "v1beta/{+parent}/examples", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to create an example in.", "required": true, "type": "string", "location": "path" }, "exampleId": { "location": "query", "type": "string", "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." } }, "id": "ces.projects.locations.apps.examples.create" }, "get": { "id": "ces.projects.locations.apps.examples.get", "path": "v1beta/{+name}", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The resource name of the example to retrieve.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$" } }, "description": "Gets details of the specified example.", "response": { "$ref": "Example" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}", "parameterOrder": [ "name" ] }, "delete": { "parameterOrder": [ "name" ], "httpMethod": "DELETE", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes the specified example.", "response": { "$ref": "Empty" }, "path": "v1beta/{+name}", "parameters": { "name": { "description": "Required. The resource name of the example to delete.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$" }, "etag": { "location": "query", "type": "string", "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." } }, "id": "ces.projects.locations.apps.examples.delete" }, "patch": { "path": "v1beta/{+name}", "parameters": { "name": { "location": "path", "type": "string", "description": "Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$" }, "updateMask": { "location": "query", "format": "google-fieldmask", "type": "string", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated." } }, "description": "Updates the specified example.", "response": { "$ref": "Example" }, "id": "ces.projects.locations.apps.examples.patch", "request": { "$ref": "Example" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}" } } }, "versions": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.versions.list", "path": "v1beta/{+parent}/versions", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListAppVersions call." }, "parent": { "description": "Required. The resource name of the app to list app versions from.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter to be applied when listing the app versions. See https://google.aip.dev/160 for more details." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details." } }, "description": "Lists all app versions in the given app.", "response": { "$ref": "ListAppVersionsResponse" } }, "create": { "id": "ces.projects.locations.apps.versions.create", "path": "v1beta/{+parent}/versions", "parameters": { "parent": { "description": "Required. The resource name of the app to create an app version in.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "appVersionId": { "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", "location": "query" } }, "description": "Creates a new app version in the given app.", "response": { "$ref": "AppVersion" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions", "request": { "$ref": "AppVersion" }, "parameterOrder": [ "parent" ] }, "get": { "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "description": "Required. The resource name of the app version to retrieve.", "required": true, "location": "path", "type": "string" } }, "response": { "$ref": "AppVersion" }, "description": "Gets details of the specified app version.", "id": "ces.projects.locations.apps.versions.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}", "httpMethod": "GET" }, "delete": { "id": "ces.projects.locations.apps.versions.delete", "path": "v1beta/{+name}", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource name of the app version to delete.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$" }, "etag": { "type": "string", "location": "query", "description": "Optional. The current etag of the app version. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app version, deletion will be blocked and an ABORTED error will be returned." } }, "description": "Deletes the specified app version.", "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}", "parameterOrder": [ "name" ] }, "restore": { "id": "ces.projects.locations.apps.versions.restore", "path": "v1beta/{+name}:restore", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource name of the app version to restore.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$" } }, "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.", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}:restore", "request": { "$ref": "RestoreAppVersionRequest" }, "parameterOrder": [ "name" ] } } }, "toolsets": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.toolsets.list", "path": "v1beta/{+parent}/toolsets", "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": { "type": "string", "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListToolsets call." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to list toolsets from.", "required": true, "type": "string", "location": "path" }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter to be applied when listing the toolsets. See https://google.aip.dev/160 for more details." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." } }, "description": "Lists toolsets in the given app.", "response": { "$ref": "ListToolsetsResponse" } }, "retrieveTools": { "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}:retrieveTools", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "toolset" ], "request": { "$ref": "RetrieveToolsRequest" }, "id": "ces.projects.locations.apps.toolsets.retrieveTools", "description": "Retrieve the list of tools included in the specified toolset.", "response": { "$ref": "RetrieveToolsResponse" }, "path": "v1beta/{+toolset}:retrieveTools", "parameters": { "toolset": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "description": "Required. The name of the toolset to retrieve the tools for. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "required": true, "type": "string", "location": "path" } } }, "create": { "path": "v1beta/{+parent}/toolsets", "parameters": { "parent": { "type": "string", "location": "path", "description": "Required. The resource name of the app to create a toolset in.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "toolsetId": { "description": "Optional. The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset.", "type": "string", "location": "query" } }, "description": "Creates a new toolset in the given app.", "response": { "$ref": "Toolset" }, "id": "ces.projects.locations.apps.toolsets.create", "request": { "$ref": "Toolset" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets" }, "get": { "response": { "$ref": "Toolset" }, "description": "Gets details of the specified toolset.", "path": "v1beta/{+name}", "parameters": { "name": { "description": "Required. The resource name of the toolset to retrieve.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$" } }, "id": "ces.projects.locations.apps.toolsets.get", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.toolsets.delete", "response": { "$ref": "Empty" }, "description": "Deletes the specified toolset.", "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the toolset to delete.", "required": true }, "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.", "location": "query", "type": "boolean" }, "etag": { "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", "location": "query" } } }, "patch": { "path": "v1beta/{+name}", "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "type": "string", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "description": "Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "required": true, "type": "string", "location": "path" } }, "description": "Updates the specified toolset.", "response": { "$ref": "Toolset" }, "id": "ces.projects.locations.apps.toolsets.patch", "request": { "$ref": "Toolset" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}" } } } } }, "operations": { "methods": { "list": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", "path": "v1beta/{+name}/operations", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "returnPartialSuccess": { "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.", "location": "query", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "The name of the operation's parent resource.", "required": true, "type": "string", "location": "path" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "ListOperationsResponse" }, "id": "ces.projects.locations.operations.list" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "ces.projects.locations.operations.delete", "path": "v1beta/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "Empty" }, "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`." }, "get": { "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta/{+name}", "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "id": "ces.projects.locations.operations.get" }, "cancel": { "id": "ces.projects.locations.operations.cancel", "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`.", "response": { "$ref": "Empty" }, "path": "v1beta/{+name}:cancel", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true } }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "CancelOperationRequest" } } } } } } } } }, "revision": "20260612", "title": "Gemini Enterprise for Customer Experience API", "kind": "discovery#restDescription", "batchPath": "batch", "version_module": true, "protocol": "rest", "documentationLink": "https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps", "servicePath": "", "ownerDomain": "google.com", "discoveryVersion": "v1", "mtlsRootUrl": "https://ces.mtls.googleapis.com/", "name": "ces", "id": "ces:v1beta", "ownerName": "Google", "version": "v1beta", "canonicalName": "Customer Engagement Suite", "parameters": { "prettyPrint": { "type": "boolean", "default": "true", "location": "query", "description": "Returns response with indentations and line breaks." }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "key": { "type": "string", "location": "query", "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." }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "quotaUser": { "type": "string", "location": "query", "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." }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "$.xgafv": { "enum": [ "1", "2" ], "location": "query", "type": "string", "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "alt": { "default": "json", "enum": [ "json", "media", "proto" ], "location": "query", "type": "string", "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ] } }, "basePath": "", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/ces": { "description": "Create, update, delete, and manage your Next Gen Agents" }, "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." } } } }, "description": "", "endpoints": [ { "location": "us", "endpointUrl": "https://ces.us.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://ces.eu.rep.googleapis.com/", "description": "Regional Endpoint", "location": "eu" } ], "schemas": { "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig": { "description": "The configuration to be used to generate an operation in the Open API schema.", "id": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig", "type": "object", "properties": { "method": { "type": "string", "description": "Required. The uri of the tool. This should include query and path parameters if any." }, "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" }, "responseJson": { "description": "Required. A sample response from the tool in JSON format.", "type": "string" } } }, "ToolCalls": { "description": "Request for the client to execute the tools and return the execution results before continuing the session.", "id": "ToolCalls", "type": "object", "properties": { "toolCalls": { "type": "array", "items": { "$ref": "ToolCall" }, "description": "Optional. The list of tool calls to execute." } } }, "AgentAgentToolset": { "id": "AgentAgentToolset", "type": "object", "properties": { "toolset": { "description": "Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string" }, "toolIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. The tools IDs to filter the toolset." } }, "description": "A toolset with a selection of its tools." }, "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.", "id": "DataStoreSettingsEngine", "type": "object", "properties": { "name": { "type": "string", "readOnly": true, "description": "Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`" }, "type": { "enum": [ "TYPE_UNSPECIFIED", "ENGINE_TYPE_SEARCH", "ENGINE_TYPE_CHAT" ], "description": "Output only. The type of the engine.", "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." ], "type": "string" } } }, "DataStore": { "description": "A DataStore resource in Vertex AI Search.", "id": "DataStore", "type": "object", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the data store was created.", "readOnly": true }, "connectorConfig": { "readOnly": true, "$ref": "DataStoreConnectorConfig", "description": "Output only. The connector config for the data store connection." }, "type": { "enum": [ "DATA_STORE_TYPE_UNSPECIFIED", "PUBLIC_WEB", "UNSTRUCTURED", "FAQ", "CONNECTOR" ], "type": "string", "description": "Output only. The type of the data store. This field is readonly and populated by the server.", "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." ] }, "name": { "type": "string", "description": "Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`" }, "documentProcessingMode": { "description": "Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.", "readOnly": true, "enumDescriptions": [ "Not specified.", "Documents are processed as documents.", "Documents are converted to chunks." ], "type": "string", "enum": [ "DOCUMENT_PROCESSING_MODE_UNSPECIFIED", "DOCUMENTS", "CHUNKS" ] }, "displayName": { "readOnly": true, "description": "Output only. The display name of the data store.", "type": "string" } } }, "FileContextFileBytes": { "id": "FileContextFileBytes", "type": "object", "properties": { "data": { "description": "Required. Raw bytes of the file.", "type": "string", "format": "byte" }, "mimeType": { "type": "string", "description": "Required. The IANA standard MIME type of the source data." }, "fileName": { "description": "Required. The name of the file provided as raw bytes.", "type": "string" } }, "description": "File provided as raw bytes." }, "EvaluationStep": { "description": "A step defines a singular action to happen during the evaluation.", "id": "EvaluationStep", "type": "object", "properties": { "userInput": { "$ref": "SessionInput", "description": "Optional. User input for the conversation." }, "expectation": { "$ref": "EvaluationGoldenExpectation", "description": "Optional. Executes an expectation on the current turn." }, "agentTransfer": { "$ref": "AgentTransfer", "description": "Optional. Transfer the conversation to a different agent." } } }, "RetrieveToolSchemaRequest": { "id": "RetrieveToolSchemaRequest", "type": "object", "properties": { "tool": { "type": "string", "description": "Optional. The name of the tool to retrieve the schema for. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}" }, "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" } }, "description": "Request message for ToolService.RetrieveToolSchema." }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds": { "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds", "type": "object", "properties": { "overallToolInvocationCorrectnessThreshold": { "description": "Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.", "type": "number", "format": "float" }, "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": { "description": "Optional. The semantic similarity channel to use for evaluation.", "enumDescriptions": [ "Metric unspecified. Defaults to TEXT.", "Use text semantic similarity.", "Use audio semantic similarity." ], "enum": [ "SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED", "TEXT", "AUDIO" ], "type": "string" } }, "description": "Turn level metrics thresholds." }, "SecuritySettings": { "description": "Project/Location level security settings for CES.", "id": "SecuritySettings", "type": "object", "properties": { "name": { "description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. Last update time of the security settings.", "type": "string", "format": "google-datetime" }, "endpointControlPolicy": { "description": "Optional. Endpoint control related settings.", "$ref": "EndpointControlPolicy" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Create time of the security settings.", "readOnly": true }, "etag": { "type": "string", "readOnly": true, "description": "Output only. Etag of the security settings." } } }, "LfA2aV1TaskStatus": { "description": "A container for the status of a task", "id": "LfA2aV1TaskStatus", "type": "object", "properties": { "message": { "description": "A message associated with the status.", "$ref": "LfA2aV1Message" }, "timestamp": { "type": "string", "format": "google-datetime", "description": "ISO 8601 Timestamp when the status was recorded. Example: \"2023-10-27T10:00:00Z\"" }, "state": { "type": "string", "description": "Required. The current state of this task.", "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." ], "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" ] } } }, "EvaluationSettings": { "description": "Settings for evaluation.", "id": "EvaluationSettings", "type": "object", "properties": { "goldenRunMethod": { "description": "Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest.", "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." ], "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ], "type": "string" }, "metricsConfig": { "description": "Optional. Configures the default metrics for evaluations.", "$ref": "EvaluationMetricsConfig" }, "scenarioConversationInitiator": { "type": "string", "description": "Optional. Who starts the conversation in a scenario evaluation.", "enumDescriptions": [ "Unspecified. Defaults to USER.", "The user starts the conversation.", "The agent starts the conversation." ], "enum": [ "SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED", "USER", "AGENT" ] }, "goldenEvaluationToolCallBehaviour": { "description": "Optional. Configures the default tool call behaviour for golden evaluations.", "enumDescriptions": [ "Unspecified tool call behavior. Will default to real tool calls.", "Use real tool calls.", "Use fake tool calls." ], "enum": [ "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED", "REAL", "FAKE" ], "type": "string" }, "scenarioEvaluationToolCallBehaviour": { "type": "string", "enumDescriptions": [ "Unspecified tool call behavior. Will default to real tool calls.", "Use real tool calls.", "Use fake tool calls." ], "enum": [ "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED", "REAL", "FAKE" ], "description": "Optional. Configures the default tool call behaviour for scenario evaluations." } } }, "SynthesizeSpeechConfig": { "id": "SynthesizeSpeechConfig", "type": "object", "properties": { "voice": { "type": "string", "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." }, "speakingRate": { "description": "Optional. The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.", "format": "double", "type": "number" } }, "description": "Configuration for how the agent response should be synthesized." }, "EvaluationResultUserGoalSatisfactionResult": { "description": "The result of a user goal satisfaction check for a conversation.", "id": "EvaluationResultUserGoalSatisfactionResult", "type": "object", "properties": { "label": { "type": "string", "description": "Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified", "readOnly": true }, "explanation": { "type": "string", "readOnly": true, "description": "Output only. The explanation for the user task satisfaction score." }, "score": { "format": "int32", "type": "integer", "description": "Output only. The user task satisfaction score. Can be -1, 0, 1.", "readOnly": true } } }, "BatchDeleteConversationsResponse": { "id": "BatchDeleteConversationsResponse", "type": "object", "properties": { "errorMessages": { "description": "Optional. A list of error messages associated with conversations that failed to be deleted.", "type": "array", "items": { "type": "string" } }, "deletedConversations": { "type": "array", "items": { "type": "string" }, "description": "The list of conversations that were successfully deleted." }, "failedConversations": { "type": "array", "items": { "type": "string" }, "description": "The list of conversations that failed to be deleted." } }, "description": "Response message for AgentService.BatchDeleteConversations." }, "LanguageSettings": { "id": "LanguageSettings", "type": "object", "properties": { "defaultLanguageCode": { "type": "string", "description": "Optional. The default language code of the app." }, "fallbackAction": { "description": "Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as \"escalate\" or \"exit\", which triggers an EndSession signal with corresponding metadata to terminate the conversation.", "deprecated": true, "type": "string" }, "supportedLanguageCodes": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of languages codes supported by the app, in addition to the `default_language_code`." }, "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" } }, "description": "Language settings of the app." }, "ChannelProfileWebWidgetConfig": { "id": "ChannelProfileWebWidgetConfig", "type": "object", "properties": { "securitySettings": { "description": "Optional. The security settings of the web widget.", "$ref": "ChannelProfileWebWidgetConfigSecuritySettings" }, "modality": { "description": "Optional. The modality of the web widget.", "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." ], "enum": [ "MODALITY_UNSPECIFIED", "CHAT_AND_VOICE", "VOICE_ONLY", "CHAT_ONLY", "CHAT_VOICE_AND_VIDEO" ], "type": "string" }, "theme": { "enumDescriptions": [ "Unknown theme.", "Light theme.", "Dark theme." ], "enum": [ "THEME_UNSPECIFIED", "LIGHT", "DARK" ], "description": "Optional. The theme of the web widget.", "type": "string" }, "webWidgetTitle": { "type": "string", "description": "Optional. The title of the web widget." } }, "description": "Message for configuration for the web widget." }, "DataStoreToolRewriterConfig": { "id": "DataStoreToolRewriterConfig", "type": "object", "properties": { "modelSettings": { "$ref": "ModelSettings", "description": "Required. Configurations for the LLM model." }, "prompt": { "description": "Optional. The prompt definition. If not set, default prompt will be used.", "type": "string" }, "disabled": { "type": "boolean", "description": "Optional. Whether the rewriter is disabled." } }, "description": "Rewriter configuration." }, "TestPersonaVoiceResponse": { "id": "TestPersonaVoiceResponse", "type": "object", "properties": { "audio": { "format": "byte", "type": "string", "description": "The audio data bytes of the synthesized voice." } }, "description": "Response message for EvaluationService.TestPersonaVoice." }, "EvaluationMetricsThresholds": { "id": "EvaluationMetricsThresholds", "type": "object", "properties": { "hallucinationMetricBehavior": { "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.", "deprecated": true, "type": "string", "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ] }, "goldenHallucinationMetricBehavior": { "type": "string", "description": "Optional. The hallucination metric behavior for golden evaluations.", "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ], "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ] }, "scenarioHallucinationMetricBehavior": { "description": "Optional. The hallucination metric behavior for scenario evaluations.", "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ], "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "type": "string" }, "goldenEvaluationMetricsThresholds": { "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds", "description": "Optional. The golden evaluation metrics thresholds." } }, "description": "Threshold settings for metrics in an Evaluation." }, "GenerateAppResourceRequestAppGenerationConfig": { "description": "The configuration to be used to generate the app.", "id": "GenerateAppResourceRequestAppGenerationConfig", "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" }, "context": { "description": "Optional. The context which describes the requirements of the agents & tools to be generated.", "type": "string" }, "gcsLocation": { "type": "string", "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://...`." }, "fileContexts": { "description": "Optional. The files to be used as context.", "type": "array", "items": { "$ref": "FileContext" } }, "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" } } }, "EndUserAuthConfigOauth2JwtBearerConfig": { "description": "JWT Profile Oauth 2.0 Authorization Grant authentication configuration.", "id": "EndUserAuthConfigOauth2JwtBearerConfig", "type": "object", "properties": { "subject": { "description": "Required. Subject 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" }, "issuer": { "description": "Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" } } }, "ExperimentConfigVersionReleaseTrafficAllocation": { "id": "ExperimentConfigVersionReleaseTrafficAllocation", "type": "object", "properties": { "id": { "type": "string", "description": "Optional. Id of the traffic allocation. Free format string, up to 128 characters." }, "trafficPercentage": { "format": "int32", "type": "integer", "description": "Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100." }, "appVersion": { "description": "Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" } }, "description": "Traffic allocation for the version release." }, "LfA2aV1Part": { "description": "`Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).", "id": "LfA2aV1Part", "type": "object", "properties": { "text": { "type": "string", "description": "The string content of the `text` part." }, "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" }, "data": { "description": "Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).", "type": "any" }, "filename": { "type": "string", "description": "An optional `filename` for the file (e.g., \"document.pdf\")." }, "raw": { "description": "The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.", "format": "byte", "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. metadata associated with this part." }, "url": { "type": "string", "description": "A `url` pointing to the file's content." } } }, "ExportOptions": { "description": "Options for exporting CES evaluation resources.", "id": "ExportOptions", "type": "object", "properties": { "exportFormat": { "type": "string", "enumDescriptions": [ "Unspecified format.", "JSON format.", "YAML format." ], "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "description": "Optional. The format to export the evaluation results in. Defaults to JSON if not specified." }, "gcsUri": { "type": "string", "description": "Optional. The Google Cloud Storage URI to write the exported Evaluation Results to." } } }, "WidgetTool": { "description": "Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.", "id": "WidgetTool", "type": "object", "properties": { "description": { "description": "Optional. The description of the widget tool.", "type": "string" }, "uiConfig": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Configuration for rendering the widget." }, "parameters": { "$ref": "Schema", "description": "Optional. The input parameters of the widget tool." }, "dataMapping": { "$ref": "WidgetToolDataMapping", "description": "Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters." }, "name": { "description": "Required. The display name of the widget tool.", "type": "string" }, "widgetType": { "type": "string", "description": "Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.", "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." ], "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" ] }, "textResponseConfig": { "description": "Optional. Configuration for always-included text responses.", "$ref": "WidgetToolTextResponseConfig" } } }, "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.", "id": "SessionConfigRemoteDialogflowQueryParameters", "type": "object", "properties": { "payload": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. The payload to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters)." }, "endUserMetadata": { "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", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "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" } } } }, "FileContext": { "id": "FileContext", "type": "object", "properties": { "fileBytes": { "$ref": "FileContextFileBytes", "description": "Optional. File provided as raw bytes." } }, "description": "Files to be used as context. Files can be provided as raw bytes." }, "CancelOperationRequest": { "id": "CancelOperationRequest", "type": "object", "properties": {}, "description": "The request message for Operations.CancelOperation." }, "EvaluationRun": { "description": "An evaluation run represents an all the evaluation results from an evaluation execution.", "id": "EvaluationRun", "type": "object", "properties": { "progress": { "description": "Output only. The progress of the evaluation run.", "readOnly": true, "$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" }, "error": { "description": "Output only. Deprecated: Use error_info instead. Errors encountered during execution.", "deprecated": true, "readOnly": true, "$ref": "Status" }, "createTime": { "readOnly": true, "description": "Output only. Timestamp when the evaluation run was created.", "type": "string", "format": "google-datetime" }, "state": { "type": "string", "readOnly": true, "enumDescriptions": [ "Evaluation run state is not specified.", "Evaluation run is running.", "Evaluation run has completed.", "The evaluation run has an error." ], "description": "Output only. The state of the evaluation run.", "enum": [ "EVALUATION_RUN_STATE_UNSPECIFIED", "RUNNING", "COMPLETED", "ERROR" ] }, "goldenRunMethod": { "type": "string", "description": "Output only. The method used to run the evaluation.", "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." ], "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ] }, "appVersionDisplayName": { "type": "string", "readOnly": true, "description": "Output only. The display name of the `app_version` that the evaluation ran against." }, "runCount": { "type": "integer", "format": "int32", "readOnly": true, "description": "Output only. The number of times the evaluations inside the run were run." }, "evaluationRunSummaries": { "type": "object", "additionalProperties": { "$ref": "EvaluationRunEvaluationRunSummary" }, "readOnly": true, "description": "Output only. Map of evaluation name to EvaluationRunSummary." }, "evaluationResults": { "description": "Output only. The evaluation results that are part of this run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`", "readOnly": true, "type": "array", "items": { "type": "string" } }, "operation": { "type": "string", "description": "Output only. The operation that created this evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation}`", "readOnly": true }, "changelog": { "type": "string", "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." }, "changelogCreateTime": { "type": "string", "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." }, "config": { "readOnly": true, "$ref": "EvaluationConfig", "description": "Output only. The configuration used in the run." }, "errorInfo": { "description": "Output only. Error information for the evaluation run.", "readOnly": true, "$ref": "EvaluationErrorInfo" }, "appVersion": { "readOnly": true, "description": "Output only. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "evaluationDataset": { "type": "string", "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}`", "readOnly": true }, "personaRunConfigs": { "type": "array", "items": { "$ref": "PersonaRunConfig" }, "description": "Output only. The configuration to use for the run per persona.", "readOnly": true }, "initiatedBy": { "description": "Output only. The user who initiated the evaluation run.", "readOnly": true, "type": "string" }, "scheduledEvaluationRun": { "type": "string", "readOnly": true, "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}`" }, "evaluationType": { "enum": [ "EVALUATION_TYPE_UNSPECIFIED", "GOLDEN", "SCENARIO", "MIXED" ], "type": "string", "description": "Output only. The type of the evaluations in this run.", "readOnly": true, "enumDescriptions": [ "Evaluation type is not specified.", "Golden evaluation.", "Scenario evaluation.", "Indicates the run includes a mix of golden and scenario evaluations." ] }, "evaluations": { "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}`", "readOnly": true, "type": "array", "items": { "type": "string" } }, "name": { "description": "Identifier. The unique identifier of the evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`", "type": "string" }, "displayName": { "description": "Optional. User-defined display name of the evaluation run. default: \" run - \".", "type": "string" }, "latencyReport": { "readOnly": true, "$ref": "LatencyReport", "description": "Output only. Latency report for the evaluation run." } } }, "EvaluationGolden": { "description": "The steps required to replay a golden conversation.", "id": "EvaluationGolden", "type": "object", "properties": { "turns": { "type": "array", "items": { "$ref": "EvaluationGoldenTurn" }, "description": "Required. The golden turns required to replay a golden conversation." }, "evaluationExpectations": { "type": "array", "items": { "type": "string" }, "description": "Optional. The evaluation expectations to evaluate the replayed conversation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}`" } } }, "WidgetToolDataMapping": { "id": "WidgetToolDataMapping", "type": "object", "properties": { "pythonScript": { "type": "string", "description": "Deprecated: Use `python_function` instead.", "deprecated": true }, "pythonFunction": { "$ref": "PythonFunction", "description": "Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format." }, "fieldMappings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. A map of widget input parameter fields to the corresponding output fields of the source tool." }, "sourceToolName": { "description": "Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`", "type": "string" }, "mode": { "type": "string", "enumDescriptions": [ "Unspecified mode.", "Use the `field_mappings` map for data transformation.", "Use the `python_script` for data transformation." ], "enum": [ "MODE_UNSPECIFIED", "FIELD_MAPPING", "PYTHON_SCRIPT" ], "description": "Optional. The mode of the data mapping." } }, "description": "Configuration for mapping data from a source tool to the widget's input parameters." }, "AgentTransfer": { "description": "Represents an event indicating the transfer of a conversation to a different agent.", "id": "AgentTransfer", "type": "object", "properties": { "targetAgent": { "description": "Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "displayName": { "type": "string", "description": "Output only. Display name of the agent.", "readOnly": true } } }, "EvaluationResultGoldenExpectationOutcome": { "id": "EvaluationResultGoldenExpectationOutcome", "type": "object", "properties": { "semanticSimilarityResult": { "description": "Output only. The result of the semantic similarity check.", "deprecated": true, "readOnly": true, "$ref": "EvaluationResultSemanticSimilarityResult" }, "outcome": { "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "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": "Output only. The outcome of the expectation." }, "observedPayload": { "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", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "observedToolResponse": { "description": "Output only. The result of the tool response expectation.", "readOnly": true, "$ref": "ToolResponse" }, "toolInvocationResult": { "readOnly": true, "$ref": "EvaluationResultGoldenExpectationOutcomeToolInvocationResult", "description": "Output only. The result of the tool invocation check." }, "observedAgentResponse": { "readOnly": true, "$ref": "Message", "description": "Output only. The result of the agent response expectation." }, "expectation": { "description": "Output only. The expectation that was evaluated.", "readOnly": true, "$ref": "EvaluationGoldenExpectation" }, "observedAgentTransfer": { "readOnly": true, "$ref": "AgentTransfer", "description": "Output only. The result of the agent transfer expectation." }, "observedToolCall": { "description": "Output only. The result of the tool call expectation.", "readOnly": true, "$ref": "ToolCall" } }, "description": "Specifies the expectation and the result of that expectation." }, "ExportAppResponse": { "id": "ExportAppResponse", "type": "object", "properties": { "appContent": { "type": "string", "format": "byte", "description": "App folder compressed as a zip file." }, "appUri": { "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which the app was exported.", "type": "string" } }, "description": "Response message for AgentService.ExportApp." }, "ActionEntityOperation": { "id": "ActionEntityOperation", "type": "object", "properties": { "entityId": { "type": "string", "description": "Required. ID of the entity." }, "operation": { "type": "string", "description": "Required. Operation to perform on the entity.", "enumDescriptions": [ "Operation type unspecified. Invalid, ConnectorTool create/update will fail.", "List operation.", "Get operation.", "Create operation.", "Update operation.", "Delete operation." ], "enum": [ "OPERATION_TYPE_UNSPECIFIED", "LIST", "GET", "CREATE", "UPDATE", "DELETE" ] } }, "description": "Entity CRUD operation specification." }, "GuardrailContentFilter": { "id": "GuardrailContentFilter", "type": "object", "properties": { "disregardDiacritics": { "type": "boolean", "description": "Optional. If true, diacritics are ignored during matching." }, "bannedContentsInAgentResponse": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of banned phrases. Applies only to agent responses." }, "bannedContentsInUserInput": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of banned phrases. Applies only to user inputs." }, "bannedContents": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of banned phrases. Applies to both user inputs and agent responses." }, "matchType": { "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": "Required. Match type for the content filter." } }, "description": "Guardrail that bans certain content from being used in the conversation." }, "QualityReportIssue": { "description": "The issue identified.", "id": "QualityReportIssue", "type": "object", "properties": { "occurrenceCount": { "type": "integer", "format": "int32", "description": "Optional. How many times this issue occurred." }, "description": { "description": "Optional. Description of the issue found.", "type": "string" }, "proposedSolution": { "type": "string", "description": "Optional. Proposed solution to fix the issue by modifying instructions or tools." } } }, "EvaluationResultScenarioRubricOutcome": { "description": "The outcome of the evaluation against the rubric.", "id": "EvaluationResultScenarioRubricOutcome", "type": "object", "properties": { "score": { "type": "number", "format": "float", "readOnly": true, "description": "Output only. The score of the conversation against the rubric." }, "rubric": { "readOnly": true, "description": "Output only. The rubric that was used to evaluate the conversation.", "type": "string" }, "scoreExplanation": { "type": "string", "description": "Output only. The rater's response to the rubric.", "readOnly": true } } }, "RemoteAgentTool": { "id": "RemoteAgentTool", "type": "object", "properties": { "agentCard": { "$ref": "AgentCard", "description": "Required. The agent card of the remote agent that this tool invokes." }, "name": { "description": "Required. The name of the tool.", "type": "string" }, "description": { "description": "Required. The description of the tool.", "type": "string" } }, "description": "Represents a tool that allows the agent to call another remote agent." }, "GuardrailLlmPromptSecurityDefaultSecuritySettings": { "id": "GuardrailLlmPromptSecurityDefaultSecuritySettings", "type": "object", "properties": { "defaultPromptTemplate": { "description": "Output only. The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY.", "readOnly": true, "type": "string" } }, "description": "Configuration for default system security settings." }, "InputAudioConfig": { "description": "InputAudioConfig configures how the CES agent should interpret the incoming audio data.", "id": "InputAudioConfig", "type": "object", "properties": { "noiseSuppressionLevel": { "type": "string", "description": "Optional. Whether to enable noise suppression on the input audio. Available values are \"low\", \"moderate\", \"high\", \"very_high\"." }, "audioEncoding": { "type": "string", "description": "Required. The encoding of the input audio data.", "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." ], "enum": [ "AUDIO_ENCODING_UNSPECIFIED", "LINEAR16", "MULAW", "ALAW" ] }, "sampleRateHertz": { "description": "Required. The sample rate (in Hertz) of the input audio data.", "type": "integer", "format": "int32" } } }, "LfA2aV1SendMessageResponse": { "id": "LfA2aV1SendMessageResponse", "type": "object", "properties": { "task": { "$ref": "LfA2aV1Task", "description": "The task created or updated by the message." }, "message": { "$ref": "LfA2aV1Message", "description": "A message from the agent." } }, "description": "Represents the response for the `SendMessage` method." }, "EvaluationExpectation": { "id": "EvaluationExpectation", "type": "object", "properties": { "name": { "type": "string", "description": "Identifier. The unique identifier of this evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`" }, "displayName": { "description": "Required. User-defined display name. Must be unique within the app.", "type": "string" }, "tags": { "description": "Optional. User-defined tags for expectations. Can be used to filter expectations.", "type": "array", "items": { "type": "string" } }, "updateTime": { "readOnly": true, "description": "Output only. Timestamp when the evaluation expectation was last updated.", "type": "string", "format": "google-datetime" }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the evaluation expectation was created." }, "etag": { "type": "string", "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." }, "llmCriteria": { "description": "Optional. Evaluation criteria based on an LLM prompt.", "$ref": "EvaluationExpectationLlmCriteria" } }, "description": "An evaluation expectation represents a specific criteria to evaluate against." }, "EvaluationResultGoldenResultTurnReplayResult": { "description": "The result of running a single turn of the golden conversation.", "id": "EvaluationResultGoldenResultTurnReplayResult", "type": "object", "properties": { "expectationOutcome": { "type": "array", "items": { "$ref": "EvaluationResultGoldenExpectationOutcome" }, "description": "Output only. The outcome of each expectation.", "readOnly": true }, "errorInfo": { "readOnly": true, "$ref": "EvaluationErrorInfo", "description": "Output only. Information about the error that occurred during this turn." }, "turnLatency": { "type": "string", "format": "google-duration", "readOnly": true, "description": "Output only. Duration of the turn." }, "overallToolInvocationResult": { "description": "Output only. The result of the overall tool invocation check.", "readOnly": true, "$ref": "EvaluationResultOverallToolInvocationResult" }, "hallucinationResult": { "description": "Output only. The result of the hallucination check.", "readOnly": true, "$ref": "EvaluationResultHallucinationResult" }, "toolOrderedInvocationScore": { "readOnly": true, "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", "format": "float" }, "semanticSimilarityResult": { "readOnly": true, "$ref": "EvaluationResultSemanticSimilarityResult", "description": "Output only. The result of the semantic similarity check." }, "toolCallLatencies": { "type": "array", "items": { "$ref": "EvaluationResultToolCallLatency" }, "readOnly": true, "description": "Output only. The latency of each tool call in the turn." }, "spanLatencies": { "description": "Output only. The latency of spans in the turn.", "readOnly": true, "type": "array", "items": { "$ref": "EvaluationResultSpanLatency" } }, "conversation": { "description": "Output only. The conversation that was generated for this turn.", "readOnly": true, "type": "string" }, "toolInvocationScore": { "type": "number", "format": "float", "readOnly": true, "description": "Output only. Deprecated. Use OverallToolInvocationResult instead.", "deprecated": true } } }, "ToolResponse": { "description": "The execution result of a specific tool from the client or the agent.", "id": "ToolResponse", "type": "object", "properties": { "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Required. The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result." }, "id": { "description": "Optional. The matching ID of the tool call the response is for.", "type": "string" }, "displayName": { "readOnly": true, "description": "Output only. Display name of the tool.", "type": "string" }, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "toolsetTool": { "description": "Optional. The toolset tool that got executed.", "$ref": "ToolsetTool" } } }, "Tool": { "description": "A tool represents an action that the CES agent can take to achieve certain goals.", "id": "Tool", "type": "object", "properties": { "clientFunction": { "$ref": "ClientFunction", "description": "Optional. The client function." }, "connectorTool": { "$ref": "ConnectorTool", "description": "Optional. The Integration Connector tool." }, "executionType": { "type": "string", "description": "Optional. The execution type of the tool.", "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" ] }, "systemTool": { "description": "Optional. The system tool.", "$ref": "SystemTool" }, "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" }, "displayName": { "type": "string", "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." }, "generatedSummary": { "description": "Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.", "readOnly": true, "type": "string" }, "toolFakeConfig": { "$ref": "ToolFakeConfig", "description": "Optional. Configuration for tool behavior in fake mode." }, "updateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the tool was last updated." }, "timeout": { "type": "string", "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." }, "etag": { "type": "string", "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." }, "fileSearchTool": { "$ref": "FileSearchTool", "description": "Optional. The file search tool." }, "agentTool": { "$ref": "AgentTool", "description": "Optional. The agent tool." }, "pythonFunction": { "description": "Optional. The python function tool.", "$ref": "PythonFunction" }, "googleSearchTool": { "$ref": "GoogleSearchTool", "description": "Optional. The google search tool." }, "dataStoreTool": { "$ref": "DataStoreTool", "description": "Optional. The data store tool." }, "widgetTool": { "$ref": "WidgetTool", "description": "Optional. The widget tool." }, "createTime": { "readOnly": true, "description": "Output only. Timestamp when the tool was created.", "type": "string", "format": "google-datetime" }, "openApiTool": { "description": "Optional. The open API tool.", "$ref": "OpenApiTool" }, "mcpTool": { "description": "Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.", "$ref": "McpTool" }, "remoteAgentTool": { "$ref": "RemoteAgentTool", "description": "Optional. The remote agent tool." } } }, "EvaluationMetricsConfigHallucinationMetricsConfig": { "id": "EvaluationMetricsConfigHallucinationMetricsConfig", "type": "object", "properties": { "enableHallucinationMetrics": { "type": "boolean", "description": "Optional. Whether to calculate hallucination metrics for the evaluation." } }, "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." }, "Blob": { "description": "Represents a blob input or output in the conversation.", "id": "Blob", "type": "object", "properties": { "mimeType": { "type": "string", "description": "Required. The IANA standard MIME type of the source data." }, "data": { "description": "Required. Raw bytes of the blob.", "format": "byte", "type": "string" } } }, "OAuthConfig": { "id": "OAuthConfig", "type": "object", "properties": { "clientId": { "description": "Required. The client ID from the OAuth provider.", "type": "string" }, "clientSecretVersion": { "description": "Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.", "type": "string" }, "tokenEndpoint": { "type": "string", "description": "Required. The token endpoint in the OAuth provider to exchange for an access token." }, "oauthGrantType": { "description": "Required. OAuth grant types.", "enumDescriptions": [ "Unspecified. Defaults to CLIENT_CREDENTIAL.", "Represents the [client credential flow](https://oauth.net/2/grant-types/client-credentials)." ], "enum": [ "OAUTH_GRANT_TYPE_UNSPECIFIED", "CLIENT_CREDENTIAL" ], "type": "string" }, "scopes": { "description": "Optional. The OAuth scopes to grant.", "type": "array", "items": { "type": "string" } } }, "description": "Configurations for authentication with OAuth." }, "PythonFunction": { "id": "PythonFunction", "type": "object", "properties": { "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": { "readOnly": true, "description": "Output only. The description of the Python function, parsed from the python code's docstring.", "type": "string" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration for the tool.", "$ref": "ServiceDirectoryConfig" }, "pythonCode": { "description": "Optional. The Python code to execute for the tool.", "type": "string" } }, "description": "A Python function tool." }, "EvaluationGoldenExpectation": { "description": "Represents a single, checkable requirement.", "id": "EvaluationGoldenExpectation", "type": "object", "properties": { "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": { "description": "Properties of the object.", "type": "any" } }, "agentTransfer": { "description": "Optional. Check that the agent transferred the conversation to a different agent.", "$ref": "AgentTransfer" }, "toolResponse": { "$ref": "ToolResponse", "description": "Optional. Check that a specific tool had the expected response." }, "agentResponse": { "$ref": "Message", "description": "Optional. Check that the agent responded with the correct response. The role \"agent\" is implied." }, "agentResponseSemanticSimilarityMetricsConfigOverride": { "description": "Optional. Overrides for agent_response semantic similarity metrics.", "$ref": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig" }, "agentResponseHallucinationMetricsConfigOverride": { "$ref": "EvaluationMetricsConfigHallucinationMetricsConfig", "description": "Optional. Overrides for agent_response hallucination metrics." }, "expectationLevelMetricsThresholdsOverride": { "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds", "description": "Optional. Overrides metrics at the step level." }, "toolCall": { "description": "Optional. Check that a specific tool was called with the parameters.", "$ref": "ToolCall" }, "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" }, "note": { "description": "Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., \"Check_Payment_Tool_Called\".", "type": "string" }, "skipEvaluation": { "description": "Optional. If set to true, this specific expectation will not be evaluated.", "type": "boolean" } } }, "AggregatedMetricsToolCallLatencyMetrics": { "id": "AggregatedMetricsToolCallLatencyMetrics", "type": "object", "properties": { "tool": { "readOnly": true, "description": "Output only. The name of the tool.", "type": "string" }, "averageLatency": { "format": "google-duration", "type": "string", "description": "Output only. The average latency of the tool calls.", "readOnly": true } }, "description": "Metrics for tool call latency." }, "AggregatedMetricsTurnLatencyMetrics": { "id": "AggregatedMetricsTurnLatencyMetrics", "type": "object", "properties": { "averageLatency": { "description": "Output only. The average latency of the turns.", "readOnly": true, "format": "google-duration", "type": "string" } }, "description": "Metrics for turn latency." }, "ClientCertificateSettings": { "id": "ClientCertificateSettings", "type": "object", "properties": { "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" }, "tlsCertificate": { "description": "Required. The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.", "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" } }, "description": "Settings for custom client certificates." }, "AgentTool": { "id": "AgentTool", "type": "object", "properties": { "name": { "description": "Required. The name of the agent tool.", "type": "string" }, "description": { "type": "string", "description": "Optional. Description of the tool's purpose." }, "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" }, "rootAgent": { "type": "string", "description": "Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", "deprecated": true } }, "description": "Represents a tool that allows the agent to call another agent." }, "ConversationLoggingSettings": { "id": "ConversationLoggingSettings", "type": "object", "properties": { "disableConversationLogging": { "description": "Optional. Whether to disable conversation logging for the sessions.", "type": "boolean" }, "retentionWindow": { "description": "Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days.", "type": "string", "format": "google-duration" } }, "description": "Settings to describe the conversation logging behaviors for the app." }, "EvaluationResultToolCallLatency": { "description": "The latency of a tool call execution.", "id": "EvaluationResultToolCallLatency", "type": "object", "properties": { "executionLatency": { "format": "google-duration", "type": "string", "description": "Output only. The latency of the tool call execution.", "readOnly": true }, "displayName": { "type": "string", "readOnly": true, "description": "Output only. The display name of the tool." }, "startTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The start time of the tool call execution." }, "endTime": { "readOnly": true, "description": "Output only. The end time of the tool call execution.", "type": "string", "format": "google-datetime" }, "tool": { "type": "string", "readOnly": true, "description": "Output only. The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`." } } }, "GoogleSearchToolPromptConfig": { "id": "GoogleSearchToolPromptConfig", "type": "object", "properties": { "voicePrompt": { "type": "string", "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." }, "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" } }, "description": "Prompt settings used by the model when processing or summarizing the google search results." }, "EvaluationExpectationLlmCriteria": { "id": "EvaluationExpectationLlmCriteria", "type": "object", "properties": { "prompt": { "description": "Required. The prompt/instructions provided to the LLM judge.", "type": "string" } }, "description": "Configuration for LLM-based evaluation criteria." }, "CloudLoggingSettings": { "description": "Settings to describe the Cloud Logging behaviors for the app.", "id": "CloudLoggingSettings", "type": "object", "properties": { "enableCloudLogging": { "type": "boolean", "description": "Optional. Whether to enable Cloud Logging for the sessions." } } }, "ListChangelogsResponse": { "description": "Response message for AgentService.ListChangelogs.", "id": "ListChangelogsResponse", "type": "object", "properties": { "nextPageToken": { "type": "string", "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." }, "changelogs": { "type": "array", "items": { "$ref": "Changelog" }, "description": "The list of changelogs." } } }, "GenerateEvaluationOperationMetadata": { "description": "Operation metadata for EvaluationService.GenerateEvaluation.", "id": "GenerateEvaluationOperationMetadata", "type": "object", "properties": {} }, "AggregatedMetricsSemanticSimilarityMetrics": { "id": "AggregatedMetricsSemanticSimilarityMetrics", "type": "object", "properties": { "score": { "readOnly": true, "description": "Output only. The average semantic similarity score (0-4).", "type": "number", "format": "float" } }, "description": "Metrics for semantic similarity results." }, "OperationMetadata": { "id": "OperationMetadata", "type": "object", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true }, "requestedCancellation": { "type": "boolean", "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "readOnly": true }, "statusMessage": { "type": "string", "readOnly": true, "description": "Output only. Human-readable status of the operation, if any." }, "endTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation finished running." } }, "description": "Represents the metadata of the long-running operation." }, "ImportEvaluationsRequestImportOptions": { "id": "ImportEvaluationsRequestImportOptions", "type": "object", "properties": { "conflictResolutionStrategy": { "type": "string", "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." ], "enum": [ "CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED", "OVERWRITE", "SKIP", "DUPLICATE" ], "description": "Optional. The strategy to use when resolving conflicts during import." } }, "description": "Configuration options for the evaluation import process. These options control how the import behaves, particularly when conflicts arise with existing evaluations data." }, "LfA2aV1SendMessageConfiguration": { "id": "LfA2aV1SendMessageConfiguration", "type": "object", "properties": { "acceptedOutputModes": { "type": "array", "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." }, "taskPushNotificationConfig": { "description": "Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request.", "$ref": "LfA2aV1TaskPushNotificationConfig" }, "returnImmediately": { "description": "If `true`, the operation returns immediately after creating the task, even if processing is still in progress. If `false` (default), the operation MUST wait until the task reaches a terminal (`COMPLETED`, `FAILED`, `CANCELED`, `REJECTED`) or interrupted (`INPUT_REQUIRED`, `AUTH_REQUIRED`) state before returning.", "type": "boolean" }, "historyLength": { "type": "integer", "format": "int32", "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." } }, "description": "Configuration of a send message request." }, "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.", "id": "EvaluationMetricsConfigUserGoalMetMetricsConfig", "type": "object", "properties": { "enableUserGoalMetMetrics": { "description": "Optional. Whether to calculate the user goal met metrics for the evaluation.", "type": "boolean" } } }, "WebSearchQuery": { "description": "Represents a single web search query and its associated search uri.", "id": "WebSearchQuery", "type": "object", "properties": { "query": { "description": "The search query text.", "type": "string" }, "uri": { "type": "string", "description": "The URI to the Google Search results page for the query." } } }, "BigQueryExportSettings": { "id": "BigQueryExportSettings", "type": "object", "properties": { "project": { "type": "string", "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`." }, "enabled": { "description": "Optional. Indicates whether the BigQuery export is enabled.", "type": "boolean" }, "dataset": { "type": "string", "description": "Optional. The BigQuery **dataset ID** to export the data to." } }, "description": "Settings to describe the BigQuery export behaviors for the app." }, "EvaluationMetricsThresholdsToolMatchingSettings": { "description": "Settings for matching tool calls.", "id": "EvaluationMetricsThresholdsToolMatchingSettings", "type": "object", "properties": { "extraToolCallBehavior": { "description": "Optional. Behavior for extra tool calls. Defaults to FAIL.", "enumDescriptions": [ "Unspecified behavior. Defaults to FAIL.", "Fail the evaluation if an extra tool call is encountered.", "Allow the extra tool call." ], "enum": [ "EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED", "FAIL", "ALLOW" ], "type": "string" } } }, "EndpointControlPolicy": { "id": "EndpointControlPolicy", "type": "object", "properties": { "enforcementScope": { "type": "string", "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." ], "enum": [ "ENFORCEMENT_SCOPE_UNSPECIFIED", "VPCSC_ONLY", "ALWAYS" ], "description": "Optional. The scope in which this policy's allowed_origins list is enforced." }, "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." }, "ImportEvaluationsOperationMetadata": { "description": "Represents the metadata of the long-running operation for EvaluationService.ImportEvaluations.", "id": "ImportEvaluationsOperationMetadata", "type": "object", "properties": { "statusMessage": { "type": "string", "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } } }, "BearerTokenConfig": { "id": "BearerTokenConfig", "type": "object", "properties": { "token": { "type": "string", "description": "Required. The bearer token. Must be in the format `$context.variables.`." } }, "description": "Configurations for authentication with a bearer token." }, "ConnectorTool": { "description": "A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview.", "id": "ConnectorTool", "type": "object", "properties": { "description": { "type": "string", "description": "Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool." }, "action": { "$ref": "Action", "description": "Required. Action for the tool to use." }, "connection": { "type": "string", "description": "Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`" }, "name": { "description": "Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.", "type": "string" }, "authConfig": { "$ref": "EndUserAuthConfig", "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." } } }, "AgentSkill": { "description": "Represents a distinct capability or function that an agent can perform.", "id": "AgentSkill", "type": "object", "properties": { "id": { "type": "string", "description": "Required. A unique identifier for the agent's skill." }, "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" } }, "name": { "type": "string", "description": "Required. A human-readable name for the skill." }, "inputModes": { "type": "array", "items": { "type": "string" }, "description": "The set of supported input media types for this skill, overriding the agent's defaults." }, "outputModes": { "description": "The set of supported output media types for this skill, overriding the agent's defaults.", "type": "array", "items": { "type": "string" } }, "description": { "description": "Required. A detailed description of the skill.", "type": "string" } } }, "ToolCall": { "id": "ToolCall", "type": "object", "properties": { "id": { "description": "Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.", "type": "string" }, "displayName": { "type": "string", "description": "Output only. Display name of the tool.", "readOnly": true }, "args": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The input parameters and values for the tool in JSON object format." }, "tool": { "type": "string", "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`" }, "toolsetTool": { "$ref": "ToolsetTool", "description": "Optional. The toolset tool to execute." } }, "description": "Request for the client or the agent to execute the specified tool." }, "EvaluationMetricsConfigExpectationsMetMetricsConfig": { "id": "EvaluationMetricsConfigExpectationsMetMetricsConfig", "type": "object", "properties": { "enableExpectationsMetMetrics": { "description": "Optional. Whether to calculate the expectation level metrics for the evaluation.", "type": "boolean" } }, "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." }, "DataStoreToolEngineSource": { "description": "Configuration for searching within an Engine, potentially targeting specific DataStores.", "id": "DataStoreToolEngineSource", "type": "object", "properties": { "filter": { "type": "string", "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" }, "engine": { "description": "Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string" }, "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" } } } }, "ExportEvaluationsRequest": { "id": "ExportEvaluationsRequest", "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "description": "Required. The resource names of the evaluations to export." }, "exportOptions": { "description": "Optional. The export options for the evaluations.", "$ref": "ExportOptions" }, "includeEvaluations": { "type": "boolean", "description": "Optional. Includes evaluations in the export. At least one of include_evaluation_results or include_evaluations must be set." }, "includeEvaluationResults": { "description": "Optional. Includes evaluation results in the export. At least one of include_evaluation_results or include_evaluations must be set.", "type": "boolean" } }, "description": "Request message for EvaluationService.ExportEvaluations." }, "EvaluationPersonaSpeechConfig": { "description": "Configuration for Text-to-Speech generation.", "id": "EvaluationPersonaSpeechConfig", "type": "object", "properties": { "speakingRate": { "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", "format": "double" }, "environment": { "type": "string", "description": "Optional. The simulated audio environment.", "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" ] }, "voiceId": { "type": "string", "description": "Optional. The specific voice identifier/accent to use. Example: \"en-US-Wavenet-D\" or \"en-GB-Standard-A\"" } } }, "AgentLlmAgent": { "id": "AgentLlmAgent", "type": "object", "properties": {}, "description": "Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model." }, "SessionInput": { "description": "Input for the session.", "id": "SessionInput", "type": "object", "properties": { "text": { "description": "Optional. Text data from the end user.", "type": "string" }, "willContinue": { "type": "boolean", "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." }, "toolResponses": { "$ref": "ToolResponses", "description": "Optional. Execution results for the tool calls from the client." }, "dtmf": { "type": "string", "description": "Optional. DTMF digits from the end user." }, "variables": { "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", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "event": { "$ref": "Event", "description": "Optional. Event input." }, "blob": { "description": "Optional. Blob data from the end user.", "$ref": "Blob" }, "image": { "$ref": "Image", "description": "Optional. Image data from the end user." }, "audio": { "format": "byte", "type": "string", "description": "Optional. Audio data from the end user." } } }, "GenerateAppResourceRequestToolGenerationConfig": { "description": "The configuration to be used to generate a tool.", "id": "GenerateAppResourceRequestToolGenerationConfig", "type": "object", "properties": { "openApiToolsetGenerationConfig": { "description": "Optional. The configuration to be used to generate an Open API schema.", "$ref": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig" }, "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" }, "fileContexts": { "type": "array", "items": { "$ref": "FileContext" }, "description": "Optional. The files to be used as context." } } }, "ListGuardrailsResponse": { "description": "Response message for AgentService.ListGuardrails.", "id": "ListGuardrailsResponse", "type": "object", "properties": { "guardrails": { "type": "array", "items": { "$ref": "Guardrail" }, "description": "The list of guardrails." }, "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" } } }, "EvaluationResultSemanticSimilarityResult": { "description": "The result of the semantic similarity check.", "id": "EvaluationResultSemanticSimilarityResult", "type": "object", "properties": { "explanation": { "type": "string", "readOnly": true, "description": "Output only. The explanation for the semantic similarity score." }, "score": { "readOnly": true, "description": "Output only. The semantic similarity score. Can be 0, 1, 2, 3, or 4.", "type": "integer", "format": "int32" }, "outcome": { "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "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": "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." }, "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" } } }, "SessionOutputDiagnosticInfo": { "description": "Contains execution details during the processing.", "id": "SessionOutputDiagnosticInfo", "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "Message" }, "description": "List of the messages that happened during the processing." }, "rootSpan": { "$ref": "Span", "description": "A trace of the entire request processing, represented as a root span. This span can contain nested child spans for specific operations." } } }, "LatencyReportLatencyMetrics": { "id": "LatencyReportLatencyMetrics", "type": "object", "properties": { "callCount": { "readOnly": true, "description": "Output only. The number of times the resource was called.", "type": "integer", "format": "int32" }, "p50Latency": { "description": "Output only. The 50th percentile latency.", "readOnly": true, "format": "google-duration", "type": "string" }, "p90Latency": { "type": "string", "format": "google-duration", "readOnly": true, "description": "Output only. The 90th percentile latency." }, "p99Latency": { "type": "string", "format": "google-duration", "readOnly": true, "description": "Output only. The 99th percentile latency." } }, "description": "Latency metrics for a component." }, "ExperimentConfigVersionRelease": { "id": "ExperimentConfigVersionRelease", "type": "object", "properties": { "state": { "type": "string", "enumDescriptions": [ "Unspecified state.", "Pending state. Experiment is pending and not valid.", "Running state. Experiment is running and valid.", "Done state. Experiment is done and no longer valid.", "Expired state. Experiment is expired and no longer valid." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "DONE", "EXPIRED" ], "description": "Optional. State of the version release." }, "trafficAllocations": { "description": "Optional. Traffic allocations for the version release.", "type": "array", "items": { "$ref": "ExperimentConfigVersionReleaseTrafficAllocation" } } }, "description": "Version release for the experiment." }, "GenerateAppResourceRequestEvaluationPersonasGenerationConfig": { "description": "The configuration to be used to generate the evaluation personas.", "id": "GenerateAppResourceRequestEvaluationPersonasGenerationConfig", "type": "object", "properties": {} }, "ModelSettings": { "description": "Model settings contains various configurations for the LLM model.", "id": "ModelSettings", "type": "object", "properties": { "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" }, "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" } } }, "DeleteEvaluationRunOperationMetadata": { "description": "Operation metadata for EvaluationService.DeleteEvaluationRun.", "id": "DeleteEvaluationRunOperationMetadata", "type": "object", "properties": {} }, "Image": { "description": "Represents an image input or output in the conversation.", "id": "Image", "type": "object", "properties": { "mimeType": { "type": "string", "description": "Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp" }, "data": { "description": "Required. Raw bytes of the image.", "type": "string", "format": "byte" } } }, "OutputAudioConfig": { "description": "OutputAudioConfig configures how the CES agent should synthesize outgoing audio responses.", "id": "OutputAudioConfig", "type": "object", "properties": { "sampleRateHertz": { "type": "integer", "format": "int32", "description": "Required. The sample rate (in Hertz) of the output audio data." }, "audioEncoding": { "description": "Required. The encoding of the output audio data.", "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." ], "enum": [ "AUDIO_ENCODING_UNSPECIFIED", "LINEAR16", "MULAW", "ALAW" ], "type": "string" } } }, "EvaluationRunEvaluationRunSummary": { "description": "Contains the summary of passed and failed result counts for a specific evaluation in an evaluation run.", "id": "EvaluationRunEvaluationRunSummary", "type": "object", "properties": { "errorCount": { "format": "int32", "type": "integer", "description": "Output only. Number of error results for the associated Evaluation in this run.", "readOnly": true }, "passedCount": { "type": "integer", "format": "int32", "readOnly": true, "description": "Output only. Number of passed results for the associated Evaluation in this run." }, "failedCount": { "type": "integer", "format": "int32", "readOnly": true, "description": "Output only. Number of failed results for the associated Evaluation in this run." } } }, "EvaluationMetricsConfig": { "id": "EvaluationMetricsConfig", "type": "object", "properties": { "goldenMetricsConfig": { "$ref": "EvaluationMetricsConfigGoldenMetricsConfig", "description": "Optional. Configuration for the golden metrics for the evaluation." }, "scenarioMetricsConfig": { "$ref": "EvaluationMetricsConfigScenarioMetricsConfig", "description": "Optional. Configuration for the scenario metrics for the evaluation." } }, "description": "Configures the metrics for an evaluation." }, "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.", "id": "AgentInterface", "type": "object", "properties": { "url": { "type": "string", "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\"" }, "protocolBinding": { "type": "string", "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`." }, "protocolVersion": { "type": "string", "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\"" }, "tenant": { "type": "string", "description": "Tenant ID to be used in the request when calling the agent." } } }, "ExportEvaluationsResponse": { "description": "Response message for EvaluationService.ExportEvaluations.", "id": "ExportEvaluationsResponse", "type": "object", "properties": { "evaluationsContent": { "format": "byte", "type": "string", "description": "The content of the exported Evaluations. This will be populated if gcs_uri was not specified in the request." }, "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" }, "failedEvaluations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Output only. A map of evaluation resource names that could not be exported, to the reason why they failed.", "readOnly": true } } }, "ErrorHandlingSettingsFallbackResponseConfig": { "id": "ErrorHandlingSettingsFallbackResponseConfig", "type": "object", "properties": { "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" } }, "maxFallbackAttempts": { "description": "Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.", "type": "integer", "format": "int32" } }, "description": "Configuration for handling fallback responses." }, "OpenApiTool": { "description": "A remote API tool defined by an OpenAPI schema.", "id": "OpenApiTool", "type": "object", "properties": { "apiAuthentication": { "$ref": "ApiAuthentication", "description": "Optional. Authentication information required by the API." }, "name": { "type": "string", "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`." }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration.", "$ref": "ServiceDirectoryConfig" }, "ignoreUnknownFields": { "type": "boolean", "description": "Optional. If true, the agent will ignore unknown fields in the API response." }, "url": { "type": "string", "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." }, "description": { "type": "string", "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`." }, "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" } } }, "GuardrailLlmPolicy": { "id": "GuardrailLlmPolicy", "type": "object", "properties": { "policyScope": { "description": "Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond.", "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." ], "enum": [ "POLICY_SCOPE_UNSPECIFIED", "USER_QUERY", "AGENT_RESPONSE", "USER_QUERY_AND_AGENT_RESPONSE" ], "type": "string" }, "modelSettings": { "$ref": "ModelSettings", "description": "Optional. Model settings." }, "failOpen": { "type": "boolean", "description": "Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail." }, "maxConversationMessages": { "description": "Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.", "format": "int32", "type": "integer" }, "prompt": { "type": "string", "description": "Required. Policy prompt." }, "allowShortUtterance": { "type": "boolean", "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." } }, "description": "Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification." }, "ScheduledEvaluationRun": { "id": "ScheduledEvaluationRun", "type": "object", "properties": { "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" }, "description": { "type": "string", "description": "Optional. User-defined description of the scheduled evaluation run." }, "createdBy": { "readOnly": true, "description": "Output only. The user who created the scheduled evaluation run.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the scheduled evaluation run was created.", "readOnly": true }, "totalExecutions": { "readOnly": true, "description": "Output only. The total number of times this run has been executed", "type": "integer", "format": "int32" }, "lastUpdatedBy": { "readOnly": true, "description": "Output only. The user who last updated the evaluation.", "type": "string" }, "nextScheduledExecutionTime": { "description": "Output only. The next time this is scheduled to execute", "readOnly": true, "format": "google-datetime", "type": "string" }, "updateTime": { "description": "Output only. Timestamp when the evaluation was last updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "etag": { "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.", "readOnly": true, "type": "string" }, "name": { "type": "string", "description": "Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}" }, "displayName": { "type": "string", "description": "Required. User-defined display name of the scheduled evaluation run config." }, "schedulingConfig": { "description": "Required. Configuration for the timing and frequency with which to execute the evaluations.", "$ref": "ScheduledEvaluationRunSchedulingConfig" }, "active": { "type": "boolean", "description": "Optional. Whether this config is active" }, "request": { "description": "Required. The RunEvaluationRequest to schedule", "$ref": "RunEvaluationRequest" } }, "description": "Represents a scheduled evaluation run configuration." }, "Span": { "id": "Span", "type": "object", "properties": { "name": { "description": "Output only. The name of the span.", "readOnly": true, "type": "string" }, "endTime": { "readOnly": true, "description": "Output only. The end time of the span.", "type": "string", "format": "google-datetime" }, "attributes": { "description": "Output only. Key-value attributes associated with the span.", "readOnly": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "startTime": { "description": "Output only. The start time of the span.", "readOnly": true, "format": "google-datetime", "type": "string" }, "childSpans": { "readOnly": true, "description": "Output only. The child spans that are nested under this span.", "type": "array", "items": { "$ref": "Span" } }, "duration": { "type": "string", "format": "google-duration", "readOnly": true, "description": "Output only. The duration of the span." } }, "description": "A span is a unit of work or a single operation during the request processing." }, "AudioRecordingConfig": { "id": "AudioRecordingConfig", "type": "object", "properties": { "gcsBucket": { "type": "string", "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`." }, "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" } }, "description": "Configuration for how the audio interactions should be recorded." }, "MetricAnalysisSettings": { "description": "Settings to describe the conversation data collection behaviors for LLM analysis metrics pipeline.", "id": "MetricAnalysisSettings", "type": "object", "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" } } }, "ListConversationsResponse": { "id": "ListConversationsResponse", "type": "object", "properties": { "conversations": { "description": "The list of conversations.", "type": "array", "items": { "$ref": "Conversation" } }, "nextPageToken": { "type": "string", "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." } }, "description": "Response message for AgentService.ListConversations." }, "ToolsetTool": { "id": "ToolsetTool", "type": "object", "properties": { "toolset": { "type": "string", "description": "Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`" }, "toolId": { "description": "Optional. The tool ID to filter the tools to retrieve the schema for.", "type": "string" } }, "description": "A tool that is created from a toolset." }, "LfA2aV1AuthenticationInfo": { "description": "Defines authentication details, used for push notifications.", "id": "LfA2aV1AuthenticationInfo", "type": "object", "properties": { "credentials": { "type": "string", "description": "Push Notification credentials. Format depends on the scheme (e.g., token for Bearer)." }, "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" } } }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds": { "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds", "type": "object", "properties": { "turnLevelMetricsThresholds": { "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds", "description": "Optional. The turn level metrics thresholds." }, "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" } }, "description": "Settings for golden evaluations." }, "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.", "id": "EndSession", "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." } } } }, "TlsConfigCaCert": { "description": "The CA certificate.", "id": "TlsConfigCaCert", "type": "object", "properties": { "displayName": { "description": "Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.", "type": "string" }, "cert": { "format": "byte", "type": "string", "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'\") ```" } } }, "QualityReport": { "description": "The report describing any identified quality issues in the app.", "id": "QualityReport", "type": "object", "properties": { "evaluationRuns": { "description": "Optional. A list of evaluation runs used to generate the quality report. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluationRun}`.", "type": "array", "items": { "type": "string" } }, "generalIssues": { "description": "Optional. General issues not specific to any agent.", "type": "array", "items": { "$ref": "QualityReportIssue" } }, "issues": { "description": "Optional. The issues grouped by agent.", "type": "array", "items": { "$ref": "QualityReportAgentIssues" } } } }, "AggregatedMetricsMetricsByAppVersion": { "description": "Metrics aggregated per app version.", "id": "AggregatedMetricsMetricsByAppVersion", "type": "object", "properties": { "appVersionId": { "type": "string", "description": "Output only. The app version ID.", "readOnly": true }, "turnLatencyMetrics": { "type": "array", "items": { "$ref": "AggregatedMetricsTurnLatencyMetrics" }, "description": "Output only. Metrics for turn latency within this app version.", "readOnly": true }, "passCount": { "readOnly": true, "description": "Output only. The number of times the evaluation passed.", "type": "integer", "format": "int32" }, "semanticSimilarityMetrics": { "readOnly": true, "description": "Output only. Metrics for semantic similarity within this app version.", "type": "array", "items": { "$ref": "AggregatedMetricsSemanticSimilarityMetrics" } }, "toolCallLatencyMetrics": { "type": "array", "items": { "$ref": "AggregatedMetricsToolCallLatencyMetrics" }, "readOnly": true, "description": "Output only. Metrics for tool call latency within this app version." }, "failCount": { "description": "Output only. The number of times the evaluation failed.", "readOnly": true, "format": "int32", "type": "integer" }, "metricsByTurn": { "type": "array", "items": { "$ref": "AggregatedMetricsMetricsByTurn" }, "description": "Output only. Metrics aggregated per turn within this app version.", "readOnly": true }, "hallucinationMetrics": { "description": "Output only. Metrics for hallucination within this app version.", "readOnly": true, "type": "array", "items": { "$ref": "AggregatedMetricsHallucinationMetrics" } }, "toolMetrics": { "type": "array", "items": { "$ref": "AggregatedMetricsToolMetrics" }, "description": "Output only. Metrics for each tool within this app version.", "readOnly": true } } }, "TransferRuleDeterministicTransfer": { "description": "Deterministic transfer rule. When the condition evaluates to true, the transfer occurs.", "id": "TransferRuleDeterministicTransfer", "type": "object", "properties": { "expressionCondition": { "description": "Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs.", "$ref": "ExpressionCondition" }, "pythonCodeCondition": { "$ref": "PythonCodeCondition", "description": "Optional. A rule that uses Python code block to evaluate the conditions. If the condition evaluates to true, the transfer occurs." } } }, "AggregatedMetricsMetricsByTurn": { "description": "Metrics aggregated per turn.", "id": "AggregatedMetricsMetricsByTurn", "type": "object", "properties": { "toolMetrics": { "type": "array", "items": { "$ref": "AggregatedMetricsToolMetrics" }, "description": "Output only. Metrics for each tool within this turn.", "readOnly": true }, "turnIndex": { "format": "int32", "type": "integer", "description": "Output only. The turn index (0-based).", "readOnly": true }, "hallucinationMetrics": { "type": "array", "items": { "$ref": "AggregatedMetricsHallucinationMetrics" }, "description": "Output only. Metrics for hallucination within this turn.", "readOnly": true }, "turnLatencyMetrics": { "type": "array", "items": { "$ref": "AggregatedMetricsTurnLatencyMetrics" }, "readOnly": true, "description": "Output only. Metrics for turn latency within this turn." }, "semanticSimilarityMetrics": { "type": "array", "items": { "$ref": "AggregatedMetricsSemanticSimilarityMetrics" }, "description": "Output only. Metrics for semantic similarity within this turn.", "readOnly": true }, "toolCallLatencyMetrics": { "description": "Output only. Metrics for tool call latency within this turn.", "readOnly": true, "type": "array", "items": { "$ref": "AggregatedMetricsToolCallLatencyMetrics" } } } }, "AudioProcessingConfig": { "description": "Configuration for how the input and output audio should be processed and delivered.", "id": "AudioProcessingConfig", "type": "object", "properties": { "ambientSoundConfig": { "$ref": "AmbientSoundConfig", "description": "Optional. Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation." }, "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" } }, "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.", "format": "google-duration", "type": "string" }, "bargeInConfig": { "$ref": "BargeInConfig", "description": "Optional. Configures the agent behavior for the user barge-in activities." } } }, "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.", "id": "App", "type": "object", "properties": { "predefinedVariableDeclarations": { "type": "array", "items": { "$ref": "AppVariableDeclaration" }, "readOnly": true, "description": "Output only. The declarations of predefined variables for the app." }, "guardrails": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`" }, "rootAgent": { "type": "string", "description": "Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`" }, "name": { "type": "string", "description": "Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`" }, "displayName": { "description": "Required. Display name of the app.", "type": "string" }, "metadata": { "type": "object", "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." }, "toolExecutionMode": { "type": "string", "description": "Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.", "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." ], "enum": [ "TOOL_EXECUTION_MODE_UNSPECIFIED", "PARALLEL", "SEQUENTIAL" ] }, "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" }, "dataStoreSettings": { "description": "Optional. The data store settings for the app.", "$ref": "DataStoreSettings" }, "evaluationSettings": { "$ref": "EvaluationSettings", "description": "Optional. The evaluation settings for the app." }, "validationErrors": { "type": "array", "items": { "type": "string" }, "description": "Output only. Misconfigurations or warnings in the app.", "readOnly": true }, "audioProcessingConfig": { "$ref": "AudioProcessingConfig", "description": "Optional. Audio processing configuration of the app." }, "etag": { "type": "string", "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." }, "variableDeclarations": { "type": "array", "items": { "$ref": "AppVariableDeclaration" }, "description": "Optional. The declarations of the variables." }, "errorHandlingSettings": { "$ref": "ErrorHandlingSettings", "description": "Optional. Error handling settings of the app." }, "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" } }, "description": { "description": "Optional. Human-readable description of the app.", "type": "string" }, "timeZoneSettings": { "description": "Optional. TimeZone settings of the app.", "$ref": "TimeZoneSettings" }, "vpcScSettings": { "$ref": "VpcScSettings", "description": "Optional. VPC-SC settings for the app." }, "deploymentCount": { "readOnly": true, "description": "Output only. Number of deployments in the app.", "type": "integer", "format": "int32" }, "globalInstruction": { "type": "string", "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." }, "pinned": { "type": "boolean", "description": "Optional. Whether the app is pinned in the app list." }, "updateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the app was last updated." }, "languageSettings": { "$ref": "LanguageSettings", "description": "Optional. Language settings of the app." }, "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" }, "loggingSettings": { "$ref": "LoggingSettings", "description": "Optional. Logging settings of the app." }, "clientCertificateSettings": { "description": "Optional. The default client certificate settings for the app.", "$ref": "ClientCertificateSettings" }, "defaultChannelProfile": { "description": "Optional. The default channel profile used by the app.", "$ref": "ChannelProfile" }, "evaluationMetricsThresholds": { "description": "Optional. The evaluation thresholds for the app.", "$ref": "EvaluationMetricsThresholds" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the app was created.", "readOnly": true } } }, "Callback": { "id": "Callback", "type": "object", "properties": { "proactiveExecutionEnabled": { "type": "boolean", "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." }, "pythonCode": { "description": "Required. The python code to execute for the callback.", "type": "string" }, "disabled": { "description": "Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.", "type": "boolean" }, "description": { "description": "Optional. Human-readable description of the callback.", "type": "string" } }, "description": "A callback defines the custom logic to be executed at various stages of agent interaction." }, "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.", "id": "ClientFunction", "type": "object", "properties": { "response": { "description": "Optional. The schema of the function response.", "$ref": "Schema" }, "name": { "type": "string", "description": "Required. The function name." }, "description": { "description": "Optional. The function description.", "type": "string" }, "parameters": { "description": "Optional. The schema of the function parameters.", "$ref": "Schema" } } }, "UploadEvaluationAudioRequest": { "id": "UploadEvaluationAudioRequest", "type": "object", "properties": { "audioContent": { "format": "byte", "type": "string", "description": "Required. The raw audio bytes. The format of the audio must be single-channel LINEAR16 with a sample rate of 16kHz (default InputAudioConfig)." }, "previousAudioGcsUri": { "description": "Optional. The Google Cloud Storage URI of the previously uploaded audio file to be deleted. Format: `gs:///`", "type": "string" } }, "description": "Request message for EvaluationService.UploadEvaluationAudio." }, "AgentRemoteDialogflowAgent": { "id": "AgentRemoteDialogflowAgent", "type": "object", "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" }, "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" }, "flowId": { "type": "string", "description": "Optional. The flow ID of the flow in the Dialogflow agent." }, "environmentId": { "type": "string", "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." }, "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" } }, "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" } }, "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" } }, "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." }, "AppVariableDeclaration": { "description": "Defines the structure and metadata for a variable.", "id": "AppVariableDeclaration", "type": "object", "properties": { "name": { "type": "string", "description": "Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores." }, "description": { "description": "Required. The description of the variable.", "type": "string" }, "schema": { "$ref": "Schema", "description": "Required. The schema of the variable." } } }, "EvaluationDataset": { "description": "An evaluation dataset represents a set of evaluations that are grouped together basaed on shared tags.", "id": "EvaluationDataset", "type": "object", "properties": { "aggregatedMetrics": { "description": "Output only. The aggregated metrics for this evaluation dataset across all runs.", "readOnly": true, "$ref": "AggregatedMetrics" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the evaluation dataset was last updated.", "readOnly": true }, "lastUpdatedBy": { "readOnly": true, "description": "Output only. The user who last updated the evaluation dataset.", "type": "string" }, "etag": { "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.", "readOnly": true, "type": "string" }, "name": { "type": "string", "description": "Identifier. The unique identifier of this evaluation dataset. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`" }, "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.", "readOnly": true, "type": "string" }, "evaluations": { "description": "Optional. Evaluations that are included in this dataset.", "type": "array", "items": { "type": "string" } }, "createTime": { "description": "Output only. Timestamp when the evaluation dataset was created.", "readOnly": true, "format": "google-datetime", "type": "string" } } }, "ImportAppResponse": { "description": "Response message for AgentService.ImportApp.", "id": "ImportAppResponse", "type": "object", "properties": { "name": { "description": "The resource name of the app that was imported.", "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" }, "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." } } }, "VpcScSettings": { "id": "VpcScSettings", "type": "object", "properties": { "allowedOrigins": { "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", "items": { "type": "string" } } }, "description": "VPC-SC settings for the app." }, "Schema": { "description": "Represents a select subset of an OpenAPI 3.0 schema object.", "id": "Schema", "type": "object", "properties": { "additionalProperties": { "description": "Optional. Can either be a boolean or an object, controls the presence of additional properties.", "$ref": "Schema" }, "defs": { "type": "object", "additionalProperties": { "$ref": "Schema" }, "description": "Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema." }, "properties": { "type": "object", "additionalProperties": { "$ref": "Schema" }, "description": "Optional. Properties of Type.OBJECT." }, "title": { "type": "string", "description": "Optional. The title of the schema." }, "nullable": { "description": "Optional. Indicates if the value may be null.", "type": "boolean" }, "maximum": { "type": "number", "format": "double", "description": "Optional. Maximum value for Type.INTEGER and Type.NUMBER." }, "uniqueItems": { "description": "Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.", "type": "boolean" }, "anyOf": { "type": "array", "items": { "$ref": "Schema" }, "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list." }, "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" }, "items": { "description": "Optional. Schema of the elements of Type.ARRAY.", "$ref": "Schema" }, "default": { "type": "any", "description": "Optional. Default value of the data." }, "prefixItems": { "type": "array", "items": { "$ref": "Schema" }, "description": "Optional. Schemas of initial elements of Type.ARRAY." }, "minimum": { "format": "double", "type": "number", "description": "Optional. Minimum value for Type.INTEGER and Type.NUMBER." }, "type": { "type": "string", "description": "Required. The type of the data.", "enumDescriptions": [ "Type unspecified.", "String type.", "Integer type.", "Number type.", "Boolean type.", "Object type.", "Array type." ], "enum": [ "TYPE_UNSPECIFIED", "STRING", "INTEGER", "NUMBER", "BOOLEAN", "OBJECT", "ARRAY" ] }, "minItems": { "format": "int64", "type": "string", "description": "Optional. Minimum number of the elements for Type.ARRAY." }, "required": { "type": "array", "items": { "type": "string" }, "description": "Optional. Required properties of Type.OBJECT." }, "description": { "type": "string", "description": "Optional. The description of the data." }, "maxItems": { "description": "Optional. Maximum number of the elements for Type.ARRAY.", "type": "string", "format": "int64" }, "enum": { "type": "array", "items": { "type": "string" }, "description": "Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}" } } }, "EvaluationResultGoldenResult": { "description": "The result of a golden evaluation.", "id": "EvaluationResultGoldenResult", "type": "object", "properties": { "turnReplayResults": { "type": "array", "items": { "$ref": "EvaluationResultGoldenResultTurnReplayResult" }, "readOnly": true, "description": "Output only. The result of running each turn of the golden conversation." }, "evaluationExpectationResults": { "readOnly": true, "description": "Output only. The results of the evaluation expectations.", "type": "array", "items": { "$ref": "EvaluationResultEvaluationExpectationResult" } } } }, "ServiceAccountAuthConfig": { "id": "ServiceAccountAuthConfig", "type": "object", "properties": { "serviceAccount": { "description": "Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.", "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used." } }, "description": "Configurations for authentication using a custom service account." }, "TriggerActionRespondImmediately": { "id": "TriggerActionRespondImmediately", "type": "object", "properties": { "responses": { "type": "array", "items": { "$ref": "TriggerActionResponse" }, "description": "Required. The canned responses for the agent to choose from. The response is chosen randomly." } }, "description": "The agent will immediately respond with a preconfigured response." }, "CitationsCitedChunk": { "id": "CitationsCitedChunk", "type": "object", "properties": { "uri": { "type": "string", "description": "URI used for citation." }, "text": { "type": "string", "description": "Text used for citation." }, "title": { "type": "string", "description": "Title of the cited document." } }, "description": "Piece of cited information." }, "McpTool": { "description": "An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details.", "id": "McpTool", "type": "object", "properties": { "nameOverride": { "type": "string", "description": "Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override." }, "description": { "description": "Optional. The description of the MCP tool.", "type": "string" }, "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" }, "customHeaders": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details." }, "state": { "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", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "STALE" ] }, "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" }, "serviceDirectoryConfig": { "$ref": "ServiceDirectoryConfig", "description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter." }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust.", "$ref": "TlsConfig" }, "inputSchema": { "description": "Optional. The schema of the input arguments of the MCP tool.", "$ref": "Schema" }, "outputSchema": { "$ref": "Schema", "description": "Optional. The schema of the output arguments of the MCP tool." } } }, "OpenApiToolset": { "description": "A toolset that contains a list of tools that are defined by an OpenAPI schema.", "id": "OpenApiToolset", "type": "object", "properties": { "apiAuthentication": { "$ref": "ApiAuthentication", "description": "Optional. Authentication information required by the API." }, "serviceDirectoryConfig": { "$ref": "ServiceDirectoryConfig", "description": "Optional. Service Directory configuration." }, "ignoreUnknownFields": { "type": "boolean", "description": "Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema." }, "url": { "type": "string", "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." }, "openApiSchema": { "type": "string", "description": "Required. The OpenAPI schema of the toolset." }, "tlsConfig": { "$ref": "TlsConfig", "description": "Optional. The TLS configuration. Includes the custom server certificates" } } }, "ServiceAgentIdTokenAuthConfig": { "description": "Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent.", "id": "ServiceAgentIdTokenAuthConfig", "type": "object", "properties": {} }, "Example": { "id": "Example", "type": "object", "properties": { "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the example was created." }, "description": { "type": "string", "description": "Optional. Human-readable description of the example." }, "displayName": { "type": "string", "description": "Required. Display name of the example." }, "name": { "description": "Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`", "type": "string" }, "invalid": { "type": "boolean", "description": "Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.", "readOnly": true }, "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" }, "etag": { "type": "string", "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." }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the example was last updated.", "readOnly": true }, "messages": { "type": "array", "items": { "$ref": "Message" }, "description": "Optional. The collection of messages that make up the conversation." } }, "description": "An example represents a sample conversation between the user and the agent(s)." }, "ApiKeyConfig": { "id": "ApiKeyConfig", "type": "object", "properties": { "requestLocation": { "description": "Required. Key location in the request.", "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" ], "type": "string" }, "keyName": { "type": "string", "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." }, "apiKeySecretVersion": { "type": "string", "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`." } }, "description": "Configurations for authentication with API key." }, "EvaluationScenarioExpectation": { "id": "EvaluationScenarioExpectation", "type": "object", "properties": { "toolExpectation": { "$ref": "EvaluationScenarioExpectationToolExpectation", "description": "Optional. The tool call and response pair to be evaluated." }, "agentResponse": { "description": "Optional. The agent response to be evaluated.", "$ref": "Message" } }, "description": "The expectation to evaluate the conversation produced by the simulation." }, "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.", "id": "Deployment", "type": "object", "properties": { "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when this deployment was created." }, "etag": { "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.", "readOnly": true, "type": "string" }, "experimentConfig": { "$ref": "ExperimentConfig", "description": "Optional. Experiment configuration for the deployment." }, "updateTime": { "description": "Output only. Timestamp when this deployment was last updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "displayName": { "description": "Required. Display name of the deployment.", "type": "string" }, "channelProfile": { "$ref": "ChannelProfile", "description": "Required. The channel profile used in the deployment." }, "name": { "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" }, "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" } } }, "RetrieveToolSchemaResponse": { "id": "RetrieveToolSchemaResponse", "type": "object", "properties": { "outputSchema": { "$ref": "Schema", "description": "The schema of the tool output parameters." }, "tool": { "type": "string", "description": "The name of the tool that the schema is for. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`" }, "toolsetTool": { "description": "The toolset tool that the schema is for.", "$ref": "ToolsetTool" }, "inputSchema": { "description": "The schema of the tool input parameters.", "$ref": "Schema" } }, "description": "Response message for ToolService.RetrieveToolSchema." }, "ListEvaluationDatasetsResponse": { "id": "ListEvaluationDatasetsResponse", "type": "object", "properties": { "evaluationDatasets": { "description": "The list of evaluation datasets.", "type": "array", "items": { "$ref": "EvaluationDataset" } }, "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" } }, "description": "Response message for EvaluationService.ListEvaluationDatasets." }, "TransferRuleDisablePlannerTransfer": { "id": "TransferRuleDisablePlannerTransfer", "type": "object", "properties": { "expressionCondition": { "$ref": "ExpressionCondition", "description": "Required. If the condition evaluates to true, planner will not be allowed to transfer to the target agent." } }, "description": "A rule that prevents the planner from transferring to the target agent." }, "ExportEvaluationResultsResponse": { "description": "Response message for EvaluationService.ExportEvaluationResults.", "id": "ExportEvaluationResultsResponse", "type": "object", "properties": { "evaluationResultsUri": { "type": "string", "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." }, "evaluationResultsContent": { "description": "The content of the exported Evaluation Results. This will be populated if gcs_uri was not specified in the request.", "type": "string", "format": "byte" } } }, "DataStoreConnectorConfig": { "id": "DataStoreConnectorConfig", "type": "object", "properties": { "collection": { "type": "string", "description": "Resource name of the collection the data store belongs to." }, "collectionDisplayName": { "description": "Display name of the collection the data store belongs to.", "type": "string" }, "dataSource": { "type": "string", "description": "The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`." } }, "description": "The connector config for the data store connection." }, "AppVersion": { "id": "AppVersion", "type": "object", "properties": { "description": { "type": "string", "description": "Optional. The description of the app version." }, "snapshot": { "readOnly": true, "$ref": "AppSnapshot", "description": "Output only. The snapshot of the app when the version is created." }, "creator": { "description": "Output only. Email of the user who created the app version.", "readOnly": true, "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the app version was created.", "readOnly": true }, "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" }, "name": { "type": "string", "description": "Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`" }, "displayName": { "description": "Optional. The display name of the app version.", "type": "string" } }, "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." }, "RunEvaluationRequest": { "id": "RunEvaluationRequest", "type": "object", "properties": { "app": { "type": "string", "description": "Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}`" }, "evaluations": { "description": "Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "type": "array", "items": { "type": "string" } }, "config": { "$ref": "EvaluationConfig", "description": "Optional. The configuration to use for the run." }, "displayName": { "description": "Optional. The display name of the evaluation run.", "type": "string" }, "goldenRunMethod": { "type": "string", "description": "Optional. The method to run the evaluation if it is a golden evaluation. If not set, default to STABLE.", "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." ], "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ] }, "generateLatencyReport": { "description": "Optional. Whether to generate a latency report for the evaluation run.", "type": "boolean" }, "evaluationDataset": { "description": "Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "type": "string" }, "appVersion": { "description": "Optional. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "personaRunConfigs": { "description": "Optional. The configuration to use for the run per persona.", "type": "array", "items": { "$ref": "PersonaRunConfig" } }, "scheduledEvaluationRun": { "type": "string", "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}`" }, "optimizationConfig": { "$ref": "OptimizationConfig", "description": "Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run." }, "runCount": { "type": "integer", "format": "int32", "description": "Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario." } }, "description": "Request message for EvaluationService.RunEvaluation." }, "Event": { "id": "Event", "type": "object", "properties": { "event": { "type": "string", "description": "Required. The name of the event." } }, "description": "Event input." }, "EvaluationResultSpanLatency": { "description": "The latency of a span execution.", "id": "EvaluationResultSpanLatency", "type": "object", "properties": { "toolset": { "readOnly": true, "$ref": "ToolsetTool", "description": "Output only. The toolset tool identifier." }, "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The end time of span.", "readOnly": true }, "model": { "type": "string", "readOnly": true, "description": "Output only. The name of the LLM span." }, "resource": { "readOnly": true, "description": "Output only. The resource name of the guardrail or tool spans.", "type": "string" }, "displayName": { "readOnly": true, "description": "Output only. The display name of the span. Applicable to tool and guardrail spans.", "type": "string" }, "startTime": { "readOnly": true, "description": "Output only. The start time of span.", "type": "string", "format": "google-datetime" }, "executionLatency": { "readOnly": true, "description": "Output only. The latency of span.", "type": "string", "format": "google-duration" }, "callback": { "type": "string", "readOnly": true, "description": "Output only. The name of the user callback span." }, "type": { "readOnly": true, "enumDescriptions": [ "Default value. This value is unused.", "Tool call span.", "User callback span.", "Guardrail span.", "LLM span." ], "description": "Output only. The type of span.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TOOL", "USER_CALLBACK", "GUARDRAIL", "LLM" ] } } }, "MockConfig": { "description": "Mock tool calls configuration for the session.", "id": "MockConfig", "type": "object", "properties": { "mockedToolCalls": { "description": "Optional. All tool calls to mock for the duration of the session.", "type": "array", "items": { "$ref": "MockedToolCall" } }, "unmatchedToolCallBehavior": { "description": "Required. Beavhior for tool calls that don't match any args patterns in mocked_tool_calls.", "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." ], "enum": [ "UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED", "FAIL", "PASS_THROUGH" ], "type": "string" } } }, "BargeInConfig": { "description": "Configuration for how the user barge-in activities should be handled.", "id": "BargeInConfig", "type": "object", "properties": { "disableBargeIn": { "type": "boolean", "description": "Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile.", "deprecated": true }, "bargeInAwareness": { "description": "Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.", "type": "boolean" } } }, "Evaluation": { "id": "Evaluation", "type": "object", "properties": { "evaluationRuns": { "description": "Output only. The EvaluationRuns that this Evaluation is associated with.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "evaluationDatasets": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Output only. List of evaluation datasets the evaluation belongs to. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`" }, "displayName": { "type": "string", "description": "Required. User-defined display name of the evaluation. Unique within an App." }, "lastCompletedResult": { "description": "Output only. The latest evaluation result for this evaluation.", "readOnly": true, "$ref": "EvaluationResult" }, "name": { "description": "Identifier. The unique identifier of this evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "type": "string" }, "invalid": { "type": "boolean", "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.", "readOnly": true }, "evaluationMetricsConfigOverride": { "$ref": "EvaluationMetricsConfig", "description": "Optional. Overrides metrics config for this specific evaluation." }, "evaluationMetricsThresholdOverride": { "$ref": "EvaluationMetricsThresholds", "description": "Optional. Overrides metrics thresholds for this specific evaluation." }, "createTime": { "readOnly": true, "description": "Output only. Timestamp when the evaluation was created.", "type": "string", "format": "google-datetime" }, "createdBy": { "description": "Output only. The user who created the evaluation.", "readOnly": true, "type": "string" }, "description": { "description": "Optional. User-defined description of the evaluation.", "type": "string" }, "tags": { "description": "Optional. User defined tags to categorize the evaluation.", "type": "array", "items": { "type": "string" } }, "lastTenResults": { "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", "items": { "$ref": "EvaluationResult" } }, "etag": { "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.", "readOnly": true, "type": "string" }, "scenario": { "description": "Optional. The config for a scenario.", "$ref": "EvaluationScenario" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the evaluation was last updated.", "readOnly": true }, "golden": { "description": "Optional. The golden steps to be evaluated.", "$ref": "EvaluationGolden" }, "lastUpdatedBy": { "description": "Output only. The user who last updated the evaluation.", "readOnly": true, "type": "string" }, "aggregatedMetrics": { "readOnly": true, "$ref": "AggregatedMetrics", "description": "Output only. The aggregated metrics for this evaluation across all runs." } }, "description": "An evaluation represents all of the information needed to simulate and evaluate an agent." }, "Status": { "id": "Status", "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" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." } }, "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)." }, "ListScheduledEvaluationRunsResponse": { "id": "ListScheduledEvaluationRunsResponse", "type": "object", "properties": { "scheduledEvaluationRuns": { "type": "array", "items": { "$ref": "ScheduledEvaluationRun" }, "description": "The list of scheduled evaluation runs." }, "nextPageToken": { "type": "string", "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." } }, "description": "Response message for EvaluationService.ListScheduledEvaluationRuns." }, "AppSnapshot": { "description": "A snapshot of the app.", "id": "AppSnapshot", "type": "object", "properties": { "examples": { "type": "array", "items": { "$ref": "Example" }, "description": "Optional. List of examples in the app." }, "guardrails": { "description": "Optional. List of guardrails in the app.", "type": "array", "items": { "$ref": "Guardrail" } }, "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" } }, "toolsets": { "type": "array", "items": { "$ref": "Toolset" }, "description": "Optional. List of toolsets in the app." }, "agents": { "description": "Optional. List of agents in the app.", "type": "array", "items": { "$ref": "Agent" } } } }, "ImportEvaluationsRequest": { "description": "Request message for EvaluationService.ImportEvaluations.", "id": "ImportEvaluationsRequest", "type": "object", "properties": { "conversationList": { "$ref": "ImportEvaluationsRequestConversationList", "description": "The conversations to import the evaluations from." }, "gcsUri": { "type": "string", "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:///`." }, "importOptions": { "$ref": "ImportEvaluationsRequestImportOptions", "description": "Optional. Options governing the import process for the evaluations." }, "csvContent": { "format": "byte", "type": "string", "description": "Raw bytes representing the csv file with the evaluations structure." } } }, "Location": { "id": "Location", "type": "object", "properties": { "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "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." } } }, "description": "A resource that represents a Google Cloud location." }, "ListToolsResponse": { "description": "Response message for AgentService.ListTools.", "id": "ListToolsResponse", "type": "object", "properties": { "tools": { "type": "array", "items": { "$ref": "Tool" }, "description": "The list of tools." }, "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" } } }, "Conversation": { "description": "A conversation represents an interaction between an end user and the CES app.", "id": "Conversation", "type": "object", "properties": { "inputTypes": { "readOnly": true, "description": "Output only. The input types of the conversation.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Unspecified input type.", "Text input.", "Event input.", "Audio input.", "Image input.", "Blob input.", "Client function tool response input.", "Variables input." ], "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" ] } }, "endTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the conversation was completed." }, "channelType": { "enum": [ "CHANNEL_TYPE_UNSPECIFIED", "TEXT", "AUDIO", "MULTIMODAL" ], "description": "DEPRECATED. Please use input_types instead.", "deprecated": true, "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." ], "type": "string" }, "appVersion": { "description": "Output only. The version of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "readOnly": true, "type": "string" }, "turnCount": { "description": "Output only. The number of turns in the conversation.", "readOnly": true, "format": "int32", "type": "integer" }, "messages": { "description": "Deprecated. Use turns instead.", "deprecated": true, "type": "array", "items": { "$ref": "Message" } }, "entryAgent": { "type": "string", "description": "Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "readOnly": true }, "languageCode": { "readOnly": true, "description": "Output only. The language code of the conversation.", "type": "string" }, "name": { "type": "string", "description": "Identifier. The unique identifier of the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`" }, "turns": { "description": "Required. The turns in the conversation.", "type": "array", "items": { "$ref": "ConversationTurn" } }, "startTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the conversation was created." }, "source": { "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." ], "description": "Output only. Indicate the source of the conversation.", "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ] }, "deployment": { "description": "Output only. The deployment of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "readOnly": true, "type": "string" } } }, "SessionConfig": { "description": "The configuration for the session.", "id": "SessionConfig", "type": "object", "properties": { "outputAudioConfig": { "$ref": "OutputAudioConfig", "description": "Optional. Configuration for generating the output audio." }, "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" }, "timeZone": { "type": "string", "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\"." }, "useToolFakes": { "description": "Optional. Whether to use tool fakes for the session. If this field is set, the agent will attempt use tool fakes instead of calling the real tools.", "type": "boolean" }, "entryAgent": { "description": "Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "historicalContexts": { "type": "array", "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." }, "inputAudioConfig": { "description": "Optional. Configuration for processing the input audio.", "$ref": "InputAudioConfig" }, "remoteDialogflowQueryParameters": { "description": "Optional. [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters) to send to the remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent when the session control is transferred to the remote agent.", "$ref": "SessionConfigRemoteDialogflowQueryParameters" }, "deployment": { "description": "Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" } } }, "McpToolset": { "description": "A toolset that contains a list of tools that are offered by the MCP server.", "id": "McpToolset", "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" }, "customHeaders": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details." }, "toolOverrides": { "type": "array", "items": { "$ref": "McpToolOverride" }, "description": "Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic." }, "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" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.", "$ref": "ServiceDirectoryConfig" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust.", "$ref": "TlsConfig" } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request." }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "description": "The response message for Locations.ListLocations." }, "EvaluationMetricsConfigScenarioMetricsConfig": { "description": "Configuration for the scenario metrics for the evaluation.", "id": "EvaluationMetricsConfigScenarioMetricsConfig", "type": "object", "properties": { "userGoalMetMetricsConfig": { "$ref": "EvaluationMetricsConfigUserGoalMetMetricsConfig", "description": "Optional. Configuration for user goal met metrics." }, "expectationsMetMetricsConfig": { "$ref": "EvaluationMetricsConfigExpectationsMetMetricsConfig", "description": "Optional. Configuration for expectation level metrics." } } }, "EvaluationGoldenTurn": { "description": "A golden turn defines a single turn in a golden conversation.", "id": "EvaluationGoldenTurn", "type": "object", "properties": { "rootSpan": { "$ref": "Span", "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." }, "turnLevelMetricsThresholdsOverride": { "description": "Optional. Overrides for turn-level metric thresholds.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds" }, "hallucinationMetricBehaviorOverride": { "description": "Optional. Override for turn-level hallucination metric behavior.", "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ], "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "type": "string" }, "steps": { "type": "array", "items": { "$ref": "EvaluationStep" }, "description": "Required. The steps required to replay a golden conversation." } } }, "ListAppVersionsResponse": { "id": "ListAppVersionsResponse", "type": "object", "properties": { "nextPageToken": { "type": "string", "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." }, "appVersions": { "description": "The list of app versions.", "type": "array", "items": { "$ref": "AppVersion" } } }, "description": "Response message for AgentService.ListAppVersions." }, "GenerateAppResourceResponse": { "description": "Response message for AgentService.GenerateAppResource.", "id": "GenerateAppResourceResponse", "type": "object", "properties": { "appSnapshot": { "$ref": "AppSnapshot", "description": "App snapshot generated by the LLM assistant. This snapshot contains the app, agents & tools generated by the LLM assistant." }, "generateResultInfo": { "$ref": "GenerateAppResourceResponseGenerateResultInfo", "description": "Additional information about the generated result." }, "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" }, "qualityReport": { "$ref": "QualityReport", "description": "The quality report generated by the LLM assistant." }, "evaluations": { "$ref": "GenerateAppResourceResponseEvaluations", "description": "Evaluations generated by the LLM assistant." }, "appResources": { "description": "The app resources generated by the LLM assistant.", "$ref": "GenerateAppResourceResponseAppResources" }, "agent": { "$ref": "Agent", "description": "Agent generated by the LLM assistant." } } }, "TriggerActionGenerativeAnswer": { "id": "TriggerActionGenerativeAnswer", "type": "object", "properties": { "prompt": { "description": "Required. The prompt to use for the generative answer.", "type": "string" } }, "description": "The agent will immediately respond with a generative answer." }, "RetrieveToolsRequest": { "id": "RetrieveToolsRequest", "type": "object", "properties": { "toolIds": { "description": "Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned.", "type": "array", "items": { "type": "string" } }, "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" } }, "description": "Request message for ToolService.RetrieveTools." }, "LfA2aV1Artifact": { "id": "LfA2aV1Artifact", "type": "object", "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Metadata included with the artifact." }, "extensions": { "type": "array", "items": { "type": "string" }, "description": "The URIs of extensions that are present or contributed to this Artifact." }, "description": { "description": "Optional. A human readable description of the artifact.", "type": "string" }, "parts": { "type": "array", "items": { "$ref": "LfA2aV1Part" }, "description": "Required. The content of the artifact. Must contain at least one part." }, "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": "Artifacts represent task outputs." }, "RunSessionRequest": { "id": "RunSessionRequest", "type": "object", "properties": { "inputs": { "description": "Required. Inputs for the session.", "type": "array", "items": { "$ref": "SessionInput" } }, "config": { "$ref": "SessionConfig", "description": "Required. The configuration for the session." } }, "description": "Request message for SessionService.RunSession." }, "ExportAppRequest": { "id": "ExportAppRequest", "type": "object", "properties": { "gcsUri": { "type": "string", "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." }, "appVersion": { "type": "string", "description": "Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`." }, "exportFormat": { "type": "string", "enumDescriptions": [ "The export format is unspecified.", "The export format is JSON.", "The export format is YAML." ], "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "description": "Required. The format to export the app in." } }, "description": "Request message for AgentService.ExportApp." }, "ListEvaluationRunsResponse": { "description": "Response message for EvaluationService.ListEvaluationRuns.", "id": "ListEvaluationRunsResponse", "type": "object", "properties": { "evaluationRuns": { "type": "array", "items": { "$ref": "EvaluationRun" }, "description": "The list of evaluation runs." }, "nextPageToken": { "type": "string", "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." } } }, "ChannelProfile": { "id": "ChannelProfile", "type": "object", "properties": { "profileId": { "type": "string", "description": "Optional. The unique identifier of the channel profile." }, "disableDtmf": { "type": "boolean", "description": "Optional. Whether to disable DTMF (dual-tone multi-frequency)." }, "disableBargeInControl": { "type": "boolean", "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." }, "webWidgetConfig": { "$ref": "ChannelProfileWebWidgetConfig", "description": "Optional. The configuration for the web widget." }, "channelType": { "enumDescriptions": [ "Unknown channel type.", "Web UI channel.", "API channel.", "Twilio channel.", "Google Telephony Platform channel.", "Contact Center as a Service (CCaaS) channel.", "Five9 channel.", "Third party contact center integration channel." ], "enum": [ "UNKNOWN", "WEB_UI", "API", "TWILIO", "GOOGLE_TELEPHONY_PLATFORM", "CONTACT_CENTER_AS_A_SERVICE", "FIVE9", "CONTACT_CENTER_INTEGRATION" ], "description": "Optional. The type of the channel profile.", "type": "string" }, "personaProperty": { "description": "Optional. The persona property of the channel profile.", "$ref": "ChannelProfilePersonaProperty" }, "noiseSuppressionLevel": { "description": "Optional. The noise suppression level of the channel profile. Available values are \"low\", \"moderate\", \"high\", \"very_high\".", "type": "string" } }, "description": "A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony." }, "GenerateChatTokenResponse": { "id": "GenerateChatTokenResponse", "type": "object", "properties": { "chatToken": { "type": "string", "description": "The session scoped token for chat widget to authenticate with Session APIs." }, "expireTime": { "description": "The time at which the chat token expires.", "format": "google-datetime", "type": "string" } }, "description": "Response message for WidgetService.GenerateChatToken." }, "ErrorHandlingSettings": { "description": "Settings to describe how errors should be handled in the app.", "id": "ErrorHandlingSettings", "type": "object", "properties": { "errorHandlingStrategy": { "enumDescriptions": [ "Unspecified error handling strategy.", "No specific handling is enabled.", "A fallback message will be returned to the user in case of system errors (e.g. LLM errors).", "An EndSession signal will be emitted in case of system errors (e.g. LLM errors)." ], "enum": [ "ERROR_HANDLING_STRATEGY_UNSPECIFIED", "NONE", "FALLBACK_RESPONSE", "END_SESSION" ], "description": "Optional. The strategy to use for error handling.", "type": "string" }, "fallbackResponseConfig": { "description": "Optional. Configuration for handling fallback responses.", "$ref": "ErrorHandlingSettingsFallbackResponseConfig" }, "endSessionConfig": { "description": "Optional. Configuration for ending the session in case of system errors (e.g. LLM errors).", "$ref": "ErrorHandlingSettingsEndSessionConfig" } } }, "GuardrailModelSafetySafetySetting": { "id": "GuardrailModelSafetySafetySetting", "type": "object", "properties": { "threshold": { "description": "Required. The harm block threshold.", "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" ], "type": "string" }, "category": { "description": "Required. The harm category.", "enumDescriptions": [ "The harm category is unspecified.", "The harm category is hate speech.", "The harm category is dangerous content.", "The harm category is harassment.", "The harm category is sexually explicit content." ], "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT" ], "type": "string" } }, "description": "Safety setting." }, "EvaluationRunProgress": { "description": "The progress of the evaluation run.", "id": "EvaluationRunProgress", "type": "object", "properties": { "completedCount": { "description": "Output only. Number of evaluation results that finished successfully. (EvaluationResult.execution_state is COMPLETED).", "readOnly": true, "format": "int32", "type": "integer" }, "errorCount": { "readOnly": true, "description": "Output only. Number of evaluation results that failed to execute. (EvaluationResult.execution_state is ERROR).", "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true, "description": "Output only. Total number of evaluation results in this run." }, "failedCount": { "description": "Output only. Number of completed evaluation results with an outcome of FAIL. (EvaluationResult.execution_state is COMPLETED and EvaluationResult.evaluation_status is FAIL).", "readOnly": true, "format": "int32", "type": "integer" }, "passedCount": { "readOnly": true, "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", "format": "int32" } } }, "LfA2aV1TaskPushNotificationConfig": { "id": "LfA2aV1TaskPushNotificationConfig", "type": "object", "properties": { "url": { "type": "string", "description": "Required. The URL where the notification should be sent." }, "authentication": { "description": "Authentication information required to send the notification.", "$ref": "LfA2aV1AuthenticationInfo" }, "tenant": { "type": "string", "description": "Optional. Tenant ID." }, "id": { "description": "The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.", "type": "string" }, "token": { "type": "string", "description": "A token unique for this task or session." }, "taskId": { "type": "string", "description": "The ID of the task this configuration is associated with." } }, "description": "A container associating a push notification configuration with a specific task." }, "ExperimentConfig": { "id": "ExperimentConfig", "type": "object", "properties": { "versionRelease": { "$ref": "ExperimentConfigVersionRelease", "description": "Optional. Version release for the experiment." } }, "description": "Experiment for the deployment." }, "GenerateAppResourceRequestEvaluationGenerationConfig": { "description": "The configuration to be used to generate the evaluations.", "id": "GenerateAppResourceRequestEvaluationGenerationConfig", "type": "object", "properties": { "datasetId": { "type": "string", "description": "Optional. The insights dataset to be used to fetch conversation data for generating the evaluations. Format: `projects/{project}/locations/{location}/datasets/{dataset}`." } } }, "EvaluationResultHallucinationResult": { "description": "The result of the hallucination check for a single turn.", "id": "EvaluationResultHallucinationResult", "type": "object", "properties": { "label": { "type": "string", "description": "Output only. The label associated with each score. Score 1: Justified Score 0: Not Justified Score -1: No Claim To Assess", "readOnly": true }, "explanation": { "description": "Output only. The explanation for the hallucination score.", "readOnly": true, "type": "string" }, "score": { "format": "int32", "type": "integer", "description": "Output only. The hallucination score. Can be -1, 0, 1.", "readOnly": true } } }, "TlsConfig": { "id": "TlsConfig", "type": "object", "properties": { "caCerts": { "description": "Required. Specifies a list of allowed custom CA certificates for HTTPS verification.", "type": "array", "items": { "$ref": "TlsConfigCaCert" } } }, "description": "The TLS configuration." }, "EvaluationResultGoldenExpectationOutcomeToolInvocationResult": { "id": "EvaluationResultGoldenExpectationOutcomeToolInvocationResult", "type": "object", "properties": { "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 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", "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ] }, "parameterCorrectnessScore": { "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.", "readOnly": true, "format": "float", "type": "number" }, "explanation": { "description": "Output only. A free text explanation for the tool invocation result.", "readOnly": true, "type": "string" } }, "description": "The result of the tool invocation check." }, "ImportAppRequestImportOptions": { "id": "ImportAppRequestImportOptions", "type": "object", "properties": { "conflictResolutionStrategy": { "description": "Optional. The strategy to use when resolving conflicts during import.", "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." ], "enum": [ "CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED", "REPLACE", "OVERWRITE" ], "type": "string" } }, "description": "Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data." }, "DataStoreToolSummarizationConfig": { "id": "DataStoreToolSummarizationConfig", "type": "object", "properties": { "disabled": { "type": "boolean", "description": "Optional. Whether summarization is disabled." }, "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" } }, "description": "Summarization configuration." }, "LatencyReport": { "description": "Latency report for the evaluation run.", "id": "LatencyReport", "type": "object", "properties": { "callbackLatencies": { "type": "array", "items": { "$ref": "LatencyReportCallbackLatency" }, "readOnly": true, "description": "Output only. Unordered list. Latency metrics for each callback." }, "guardrailLatencies": { "type": "array", "items": { "$ref": "LatencyReportGuardrailLatency" }, "description": "Output only. Unordered list. Latency metrics for each guardrail.", "readOnly": true }, "toolLatencies": { "readOnly": true, "description": "Output only. Unordered list. Latency metrics for each tool.", "type": "array", "items": { "$ref": "LatencyReportToolLatency" } }, "llmCallLatencies": { "description": "Output only. Unordered list. Latency metrics for each LLM call.", "readOnly": true, "type": "array", "items": { "$ref": "LatencyReportLlmCallLatency" } }, "sessionCount": { "description": "Output only. The total number of sessions considered in the latency report.", "readOnly": true, "format": "int32", "type": "integer" } } }, "Message": { "description": "A message within a conversation.", "id": "Message", "type": "object", "properties": { "eventTime": { "description": "Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.", "type": "string", "format": "google-datetime" }, "chunks": { "type": "array", "items": { "$ref": "Chunk" }, "description": "Optional. Content of the message as a series of chunks." }, "role": { "type": "string", "description": "Optional. The role within the conversation, e.g., user, agent." } } }, "MockedToolCall": { "id": "MockedToolCall", "type": "object", "properties": { "expectedArgsPattern": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "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." }, "toolId": { "type": "string", "description": "Optional. The name of the tool to mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`" }, "toolset": { "description": "Optional. The toolset to mock.", "$ref": "ToolsetTool" }, "tool": { "description": "Optional. Deprecated. Use tool_identifier instead.", "deprecated": true, "type": "string" }, "mockResponse": { "description": "Optional. The mock response / output to return if the tool call args / inputs match the pattern.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } }, "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." }, "DataStoreTool": { "id": "DataStoreTool", "type": "object", "properties": { "boostSpecs": { "description": "Optional. Boost specification to boost certain documents.", "type": "array", "items": { "$ref": "DataStoreToolBoostSpecs" } }, "filterParameterBehavior": { "enumDescriptions": [ "Default filter behavior. Include filter parameter for connector datastores. For the rest of the datastore types, the filter input parameter is omitted.", "Always include filter parameter for all datastore types.", "The filter parameter is never included in the list of tool parameters, regardless of the datastore type." ], "enum": [ "FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED", "ALWAYS_INCLUDE", "NEVER_INCLUDE" ], "description": "Optional. The filter parameter behavior.", "type": "string" }, "name": { "description": "Required. The data store tool name.", "type": "string" }, "modalityConfigs": { "description": "Optional. The modality configs for the data store.", "type": "array", "items": { "$ref": "DataStoreToolModalityConfig" } }, "engineSource": { "$ref": "DataStoreToolEngineSource", "description": "Optional. Search within an Engine (potentially across multiple DataStores)." }, "description": { "type": "string", "description": "Optional. The tool description." }, "dataStoreSource": { "description": "Optional. Search within a single specific DataStore.", "$ref": "DataStoreToolDataStoreSource" } }, "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." }, "ListExamplesResponse": { "description": "Response message for AgentService.ListExamples.", "id": "ListExamplesResponse", "type": "object", "properties": { "nextPageToken": { "type": "string", "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." }, "examples": { "description": "The list of examples.", "type": "array", "items": { "$ref": "Example" } } } }, "GenerateAppResourceResponseEvaluations": { "description": "The list of evaluations generated by the LLM assistant.", "id": "GenerateAppResourceResponseEvaluations", "type": "object", "properties": { "evaluations": { "type": "array", "items": { "$ref": "Evaluation" }, "description": "The list of generated evaluations." } } }, "LfA2aV1Task": { "id": "LfA2aV1Task", "type": "object", "properties": { "id": { "description": "Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task.", "type": "string" }, "status": { "description": "Required. The current status of a `Task`, including `state` and a `message`.", "$ref": "LfA2aV1TaskStatus" }, "history": { "type": "array", "items": { "$ref": "LfA2aV1Message" }, "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`." }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task." }, "contextId": { "description": "Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages).", "type": "string" }, "artifacts": { "type": "array", "items": { "$ref": "LfA2aV1Artifact" }, "description": "A set of output artifacts for a `Task`." } }, "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." }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "type": "array", "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request." }, "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" } } } }, "SystemTool": { "description": "Pre-defined system tool.", "id": "SystemTool", "type": "object", "properties": { "name": { "type": "string", "description": "Required. The name of the system tool." }, "description": { "description": "Output only. The description of the system tool.", "readOnly": true, "type": "string" } } }, "LatencyReportCallbackLatency": { "id": "LatencyReportCallbackLatency", "type": "object", "properties": { "stage": { "type": "string", "description": "Output only. The stage of the callback.", "readOnly": true }, "latencyMetrics": { "description": "Output only. The latency metrics for the callback.", "readOnly": true, "$ref": "LatencyReportLatencyMetrics" } }, "description": "Latency metrics for a single callback." }, "EndUserAuthConfigOauth2AuthCodeConfig": { "description": "Oauth 2.0 Authorization Code authentication configuration.", "id": "EndUserAuthConfigOauth2AuthCodeConfig", "type": "object", "properties": { "oauthToken": { "type": "string", "description": "Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`." } } }, "LoggingSettings": { "description": "Settings to describe the logging behaviors for the app.", "id": "LoggingSettings", "type": "object", "properties": { "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" }, "cloudLoggingSettings": { "description": "Optional. Settings to describe the Cloud Logging behaviors for the app.", "$ref": "CloudLoggingSettings" }, "conversationLoggingSettings": { "description": "Optional. Settings to describe the conversation logging behaviors for the app.", "$ref": "ConversationLoggingSettings" }, "metricAnalysisSettings": { "description": "Optional. Settings to describe the conversation data collection behaviors for the LLM analysis pipeline for the app.", "$ref": "MetricAnalysisSettings" }, "unredactedAudioRecordingConfig": { "$ref": "AudioRecordingConfig", "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." }, "redactionConfig": { "$ref": "RedactionConfig", "description": "Optional. Configuration for how sensitive data should be redacted." }, "audioRecordingConfig": { "$ref": "AudioRecordingConfig", "description": "Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig." }, "bigqueryExportSettings": { "description": "Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig.", "$ref": "BigQueryExportSettings" } } }, "DataStoreToolBoostSpec": { "id": "DataStoreToolBoostSpec", "type": "object", "properties": { "conditionBoostSpecs": { "type": "array", "items": { "$ref": "DataStoreToolBoostSpecConditionBoostSpec" }, "description": "Required. A list of boosting specifications." } }, "description": "Boost specification to boost certain documents." }, "EvaluationErrorInfo": { "id": "EvaluationErrorInfo", "type": "object", "properties": { "errorMessage": { "type": "string", "readOnly": true, "description": "Output only. The error message." }, "sessionId": { "readOnly": true, "description": "Output only. The session ID for the conversation that caused the error.", "type": "string" }, "userFacingErrorMessage": { "description": "Output only. The user facing error message.", "readOnly": true, "type": "string" }, "errorType": { "type": "string", "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.", "enum": [ "ERROR_TYPE_UNSPECIFIED", "RUNTIME_FAILURE", "CONVERSATION_RETRIEVAL_FAILURE", "METRIC_CALCULATION_FAILURE", "EVALUATION_UPDATE_FAILURE", "QUOTA_EXHAUSTED", "USER_SIMULATION_FAILURE" ] } }, "description": "Information about an error encountered during an evaluation execution." }, "DataStoreToolGroundingConfig": { "description": "Grounding configuration.", "id": "DataStoreToolGroundingConfig", "type": "object", "properties": { "groundingLevel": { "format": "float", "type": "number", "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." }, "disabled": { "description": "Optional. Whether grounding is disabled.", "type": "boolean" } } }, "AggregatedMetrics": { "id": "AggregatedMetrics", "type": "object", "properties": { "metricsByAppVersion": { "readOnly": true, "description": "Output only. Aggregated metrics, grouped by app version ID.", "type": "array", "items": { "$ref": "AggregatedMetricsMetricsByAppVersion" } } }, "description": "Aggregated metrics for an evaluation or evaluation dataset." }, "Action": { "id": "Action", "type": "object", "properties": { "outputFields": { "type": "array", "items": { "type": "string" }, "description": "Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned." }, "connectionActionId": { "type": "string", "description": "ID of a Connection action for the tool to use." }, "entityOperation": { "$ref": "ActionEntityOperation", "description": "Entity operation configuration for the tool to use." }, "inputFields": { "description": "Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.", "type": "array", "items": { "type": "string" } } }, "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." }, "LatencyReportToolLatency": { "description": "Latency metrics for a single tool.", "id": "LatencyReportToolLatency", "type": "object", "properties": { "tool": { "type": "string", "description": "Output only. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.", "readOnly": true }, "toolsetTool": { "description": "Output only. The toolset tool identifier.", "readOnly": true, "$ref": "ToolsetTool" }, "latencyMetrics": { "readOnly": true, "$ref": "LatencyReportLatencyMetrics", "description": "Output only. The latency metrics for the tool." }, "toolDisplayName": { "type": "string", "readOnly": true, "description": "Output only. The display name of the tool." } } }, "ToolFakeConfig": { "description": "Configuration for tool behavior in fake mode.", "id": "ToolFakeConfig", "type": "object", "properties": { "codeBlock": { "description": "Optional. Code block which will be executed instead of a real tool call.", "$ref": "CodeBlock" }, "enableFakeMode": { "type": "boolean", "description": "Optional. Whether the tool is using fake mode." } } }, "TriggerActionResponse": { "description": "Represents a response from the agent.", "id": "TriggerActionResponse", "type": "object", "properties": { "text": { "type": "string", "description": "Required. Text for the agent to respond with." }, "disabled": { "type": "boolean", "description": "Optional. Whether the response is disabled. Disabled responses are not used by the agent." } } }, "ListToolsetsResponse": { "id": "ListToolsetsResponse", "type": "object", "properties": { "toolsets": { "description": "The list of toolsets.", "type": "array", "items": { "$ref": "Toolset" } }, "nextPageToken": { "type": "string", "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." } }, "description": "Response message for AgentService.ListToolsets." }, "GenerateAppResourceRequest": { "id": "GenerateAppResourceRequest", "type": "object", "properties": { "agent": { "$ref": "Agent", "description": "The agent resource to be used by the LLM assistant, can be empty for generating a new agent." }, "qualityReportGenerationConfig": { "description": "Optional. The configuration to be used for quality report generation.", "$ref": "GenerateAppResourceRequestQualityReportGenerationConfig" }, "hillClimbingFixConfig": { "description": "Optional. The configuration to be used for hill climbing fixes.", "$ref": "GenerateAppResourceRequestHillClimbingFixConfig" }, "toolGenerationConfig": { "$ref": "GenerateAppResourceRequestToolGenerationConfig", "description": "Optional. The configuration to be used to generate the tool." }, "evaluationPersonasGenerationConfig": { "$ref": "GenerateAppResourceRequestEvaluationPersonasGenerationConfig", "description": "Optional. The configuration to be used to generate the evaluation personas." }, "tool": { "$ref": "Tool", "description": "The tool resource to be used by the LLM assistant, can be empty for generating a new tool." }, "toolset": { "description": "The toolset resource to be used by the LLM assistant, can be empty for generating a new toolset.", "$ref": "Toolset" }, "refineInstructions": { "type": "array", "items": { "$ref": "GenerateAppResourceRequestRefineInstructions" }, "description": "Optional. List of refine instructions to be used to refine the resource." }, "appGenerationConfig": { "$ref": "GenerateAppResourceRequestAppGenerationConfig", "description": "Optional. The configuration to be used to generate the agents and tools." }, "evaluationGenerationConfig": { "description": "Optional. The configuration to be used to generate the evaluations.", "$ref": "GenerateAppResourceRequestEvaluationGenerationConfig" } }, "description": "Request message for AgentService.GenerateAppResource." }, "RedactionConfig": { "description": "Configuration to instruct how sensitive data should be handled.", "id": "RedactionConfig", "type": "object", "properties": { "deidentifyTemplate": { "description": "Optional. [DLP](https://cloud.google.com/dlp/docs) deidentify template name to instruct on how to de-identify content. Format: `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}`", "type": "string" }, "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" } } }, "McpToolOverride": { "id": "McpToolOverride", "type": "object", "properties": { "tool": { "type": "string", "description": "Required. The original name of the tool as it is emitted by the MCP server." }, "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" }, "descriptionOverride": { "description": "Optional. If present, this tool uses this description instead of the original description from the server.", "type": "string" }, "snapshot": { "description": "Output only. If present, this tool is \"Pinned\" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present.", "readOnly": true, "$ref": "McpToolDefinition" } }, "description": "Overrides associated with a given tool in a Toolset. This enables \"pinning\" or \"overriding\" of tool definitions from the external dynamic server." }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "type": "object", "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "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." }, "response": { "type": "object", "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`." }, "done": { "type": "boolean", "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." } } }, "ToolResponses": { "description": "Execution results for the requested tool calls from the client.", "id": "ToolResponses", "type": "object", "properties": { "toolResponses": { "description": "Optional. The list of tool execution results.", "type": "array", "items": { "$ref": "ToolResponse" } } } }, "EvaluationResultScenarioResult": { "description": "The outcome of a scenario evaluation.", "id": "EvaluationResultScenarioResult", "type": "object", "properties": { "hallucinationResult": { "type": "array", "items": { "$ref": "EvaluationResultHallucinationResult" }, "description": "Output only. The result of the hallucination check. There will be one hallucination result for each turn in the conversation.", "readOnly": true }, "toolCallLatencies": { "readOnly": true, "description": "Output only. The latency of each tool call execution in the conversation.", "type": "array", "items": { "$ref": "EvaluationResultToolCallLatency" } }, "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.", "readOnly": true, "type": "boolean" }, "taskCompletionResult": { "description": "Output only. The result of the task completion check.", "deprecated": true, "readOnly": true, "$ref": "EvaluationResultTaskCompletionResult" }, "allExpectationsSatisfied": { "description": "Output only. Whether all expectations were satisfied for this turn.", "readOnly": true, "type": "boolean" }, "spanLatencies": { "readOnly": true, "description": "Output only. The latency of spans in the conversation.", "type": "array", "items": { "$ref": "EvaluationResultSpanLatency" } }, "expectationOutcomes": { "type": "array", "items": { "$ref": "EvaluationResultScenarioExpectationOutcome" }, "readOnly": true, "description": "Output only. The outcome of each expectation." }, "rubricOutcomes": { "readOnly": true, "description": "Output only. The outcome of the rubric.", "type": "array", "items": { "$ref": "EvaluationResultScenarioRubricOutcome" } }, "userGoalSatisfactionResult": { "readOnly": true, "$ref": "EvaluationResultUserGoalSatisfactionResult", "description": "Output only. The result of the user goal satisfaction check." }, "conversation": { "readOnly": true, "description": "Output only. The conversation that was generated in the scenario.", "type": "string" }, "task": { "readOnly": true, "description": "Output only. The task that was used when running the scenario for this result.", "type": "string" }, "userFacts": { "type": "array", "items": { "$ref": "EvaluationScenarioUserFact" }, "readOnly": true, "description": "Output only. The user facts that were used by the scenario for this result." }, "evaluationExpectationResults": { "type": "array", "items": { "$ref": "EvaluationResultEvaluationExpectationResult" }, "readOnly": true, "description": "Output only. The results of the evaluation expectations." } } }, "Toolset": { "description": "A toolset represents a group of dynamically managed tools that can be used by the agent.", "id": "Toolset", "type": "object", "properties": { "openApiToolset": { "description": "Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema.", "$ref": "OpenApiToolset" }, "updateTime": { "readOnly": true, "description": "Output only. Timestamp when the toolset was last updated.", "type": "string", "format": "google-datetime" }, "connectorToolset": { "$ref": "ConnectorToolset", "description": "Optional. A toolset that generates tools from an Integration Connectors Connection." }, "etag": { "type": "string", "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." }, "name": { "description": "Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string" }, "mcpToolset": { "$ref": "McpToolset", "description": "Optional. A toolset that contains a list of tools that are offered by the MCP server." }, "displayName": { "type": "string", "description": "Optional. The display name of the toolset. Must be unique within the same app." }, "toolFakeConfig": { "$ref": "ToolFakeConfig", "description": "Optional. Configuration for tools behavior in fake mode." }, "description": { "type": "string", "description": "Optional. The description of the toolset." }, "executionType": { "enumDescriptions": [ "The execution type is unspecified. Defaults to `SYNCHRONOUS` if unspecified.", "The tool is executed synchronously. The session is blocked until the tool returns.", "The tool is executed asynchronously. The session will continue while the tool is executing." ], "enum": [ "EXECUTION_TYPE_UNSPECIFIED", "SYNCHRONOUS", "ASYNCHRONOUS" ], "description": "Optional. The execution type of the tools in the toolset.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the toolset was created.", "readOnly": true } } }, "ErrorHandlingSettingsEndSessionConfig": { "id": "ErrorHandlingSettingsEndSessionConfig", "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" } }, "description": "Configuration for ending the session in case of system errors (e.g. LLM errors)." }, "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).", "id": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "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": { "type": "number", "format": "float", "description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above." } } }, "WidgetToolTextResponseConfig": { "id": "WidgetToolTextResponseConfig", "type": "object", "properties": { "staticText": { "type": "string", "description": "Optional. The static text response to return when type is STATIC." }, "type": { "description": "Optional. The strategy for providing the text response.", "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." ], "enum": [ "TYPE_UNSPECIFIED", "NONE", "LLM_GENERATED", "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" } }, "description": "Configuration for the text response returned with the widget." }, "DataStoreToolDataStoreSource": { "id": "DataStoreToolDataStoreSource", "type": "object", "properties": { "filter": { "type": "string", "description": "Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata" }, "dataStore": { "$ref": "DataStore", "description": "Optional. The data store." } }, "description": "Configuration for searching within a specific DataStore." }, "DataStoreToolModalityConfig": { "id": "DataStoreToolModalityConfig", "type": "object", "properties": { "modalityType": { "description": "Required. The modality type.", "enumDescriptions": [ "Unspecified modality type.", "Text modality.", "Audio modality." ], "enum": [ "MODALITY_TYPE_UNSPECIFIED", "TEXT", "AUDIO" ], "type": "string" }, "rewriterConfig": { "description": "Optional. The rewriter config.", "$ref": "DataStoreToolRewriterConfig" }, "summarizationConfig": { "description": "Optional. The summarization config.", "$ref": "DataStoreToolSummarizationConfig" }, "groundingConfig": { "$ref": "DataStoreToolGroundingConfig", "description": "Optional. The grounding configuration." } }, "description": "If specified, will apply the given configuration for the specified modality." }, "RestoreAppVersionRequest": { "description": "Request message for AgentService.RestoreAppVersion", "id": "RestoreAppVersionRequest", "type": "object", "properties": {} }, "Changelog": { "description": "Changelogs represent a change made to the app or to an resource within the app.", "id": "Changelog", "type": "object", "properties": { "displayName": { "type": "string", "description": "Output only. Display name of the change. It typically should be the display name of the resource that was changed.", "readOnly": true }, "sequenceNumber": { "readOnly": true, "description": "Output only. The monotonically increasing sequence number of the changelog.", "type": "string", "format": "int64" }, "name": { "type": "string", "description": "Identifier. The unique identifier of the changelog. Format: `projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}`" }, "originalResource": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "readOnly": true, "description": "Output only. The original resource before the change." }, "newResource": { "readOnly": true, "description": "Output only. The new resource after the change.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "createTime": { "readOnly": true, "description": "Output only. The time when the change was made.", "type": "string", "format": "google-datetime" }, "resourceType": { "type": "string", "description": "Output only. The type of the resource that was changed.", "readOnly": true }, "description": { "readOnly": true, "description": "Output only. Description of the change. which typically captures the changed fields in the resource.", "type": "string" }, "author": { "description": "Output only. Email address of the change author.", "readOnly": true, "type": "string" }, "action": { "type": "string", "description": "Output only. The action that was performed on the resource.", "readOnly": true }, "dependentResources": { "type": "array", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "readOnly": true, "description": "Output only. The dependent resources that were changed." }, "resource": { "type": "string", "readOnly": true, "description": "Output only. The resource that was changed." } } }, "Chunk": { "description": "A chunk of content within a message.", "id": "Chunk", "type": "object", "properties": { "updatedVariables": { "description": "A struct represents variables that were updated in the conversation, keyed by variable names.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "agentTransfer": { "$ref": "AgentTransfer", "description": "Optional. Agent transfer event." }, "text": { "type": "string", "description": "Optional. Text data." }, "toolResponse": { "description": "Optional. Tool execution response.", "$ref": "ToolResponse" }, "defaultVariables": { "description": "A struct represents default variables at the start of the conversation, keyed by variable names.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "image": { "description": "Optional. Image data.", "$ref": "Image" }, "payload": { "description": "Optional. Custom payload data.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "blob": { "$ref": "Blob", "description": "Optional. Blob data." }, "transcript": { "description": "Optional. Transcript associated with the audio.", "type": "string" }, "toolCall": { "$ref": "ToolCall", "description": "Optional. Tool execution request." } } }, "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig": { "description": "The configuration to be used to generate an Open API schema.", "id": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig", "type": "object", "properties": { "operationGenerationConfigs": { "type": "array", "items": { "$ref": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig" }, "description": "Required. The list of operations to be added to the Open API schema." }, "uri": { "type": "string", "description": "Required. The base uri of the tool." } } }, "GenerateAppResourceRequestQualityReportGenerationConfig": { "id": "GenerateAppResourceRequestQualityReportGenerationConfig", "type": "object", "properties": { "evaluationRun": { "description": "Required. The evaluation run used to inform quality report analysis.", "type": "string" } }, "description": "The configuration to be used for quality report generation." }, "ChannelProfileWebWidgetConfigSecuritySettings": { "description": "Security settings for the web widget.", "id": "ChannelProfileWebWidgetConfigSecuritySettings", "type": "object", "properties": { "allowedOrigins": { "type": "array", "items": { "type": "string" }, "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\"" }, "enableOriginCheck": { "type": "boolean", "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." }, "enablePublicAccess": { "type": "boolean", "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." }, "enableRecaptcha": { "type": "boolean", "description": "Optional. Indicates whether reCAPTCHA verification for the web widget is enabled." } } }, "GenerateAppResourceRequestRefineInstructions": { "id": "GenerateAppResourceRequestRefineInstructions", "type": "object", "properties": { "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\".", "format": "google-fieldmask", "type": "string" }, "startIndex": { "format": "int64", "type": "string", "description": "Required. The first character (inclusive) of the text to refine." }, "endIndex": { "format": "int64", "type": "string", "description": "Required. The last character (inclusive) of the text to refine." }, "instructions": { "description": "Required. The instructions to refine the resource.", "type": "string" } }, "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\"." }, "TimeZoneSettings": { "id": "TimeZoneSettings", "type": "object", "properties": { "timeZone": { "type": "string", "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." } }, "description": "TimeZone settings of the app." }, "EvaluationScenario": { "description": "The config for a scenario", "id": "EvaluationScenario", "type": "object", "properties": { "taskCompletionBehavior": { "type": "string", "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.", "deprecated": true, "enum": [ "TASK_COMPLETION_BEHAVIOR_UNSPECIFIED", "TASK_SATISFIED", "TASK_REJECTED" ] }, "scenarioExpectations": { "type": "array", "items": { "$ref": "EvaluationScenarioExpectation" }, "description": "Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation." }, "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." } }, "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." ], "enum": [ "USER_GOAL_BEHAVIOR_UNSPECIFIED", "USER_GOAL_SATISFIED", "USER_GOAL_REJECTED", "USER_GOAL_IGNORED" ], "description": "Optional. The expected behavior of the user goal.", "type": "string" }, "evaluationExpectations": { "type": "array", "items": { "type": "string" }, "description": "Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}`" }, "rubrics": { "type": "array", "items": { "type": "string" }, "description": "Required. The rubrics to score the scenario against." }, "maxTurns": { "description": "Optional. The maximum number of turns to simulate. If not specified, the simulation will continue until the task is complete.", "format": "int32", "type": "integer" }, "task": { "type": "string", "description": "Required. The task to be targeted by the scenario." }, "userFacts": { "type": "array", "items": { "$ref": "EvaluationScenarioUserFact" }, "description": "Optional. The user facts to be used by the scenario." } } }, "ImportEvaluationsResponse": { "description": "Response message for EvaluationService.ImportEvaluations.", "id": "ImportEvaluationsResponse", "type": "object", "properties": { "evaluationRunImportFailureCount": { "description": "The number of evaluation runs that either failed to import entirely or completed import with one or more errors.", "format": "int32", "type": "integer" }, "evaluations": { "description": "The list of evaluations that were imported into the app.", "type": "array", "items": { "$ref": "Evaluation" } }, "errorMessages": { "type": "array", "items": { "type": "string" }, "description": "Optional. A list of error messages associated with evaluations that failed to be imported." }, "evaluationRuns": { "description": "The list of evaluation runs that were imported into the app.", "type": "array", "items": { "$ref": "EvaluationRun" } }, "importFailureCount": { "description": "The number of evaluations that either failed to import entirely or completed import with one or more errors.", "type": "integer", "format": "int32" }, "evaluationResults": { "description": "The list of evaluation results that were imported into the app.", "type": "array", "items": { "$ref": "EvaluationResult" } }, "evaluationResultImportFailureCount": { "format": "int32", "type": "integer", "description": "The number of evaluation results that either failed to import entirely or completed import with one or more errors." } } }, "ConversationTurn": { "description": "All information about a single turn in the conversation.", "id": "ConversationTurn", "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" } } } }, "ImportEvaluationsRequestConversationList": { "id": "ImportEvaluationsRequestConversationList", "type": "object", "properties": { "conversations": { "type": "array", "items": { "type": "string" }, "description": "Optional. Conversation resource names." } }, "description": "A list of conversation resource names." }, "ExpressionCondition": { "description": "Expression condition based on session state.", "id": "ExpressionCondition", "type": "object", "properties": { "expression": { "type": "string", "description": "Required. The string representation of cloud.api.Expression condition." } } }, "ListAgentsResponse": { "description": "Response message for AgentService.ListAgents.", "id": "ListAgentsResponse", "type": "object", "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" } } }, "Agent": { "id": "Agent", "type": "object", "properties": { "guardrails": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`" }, "afterToolCallbacks": { "type": "array", "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." }, "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" }, "displayName": { "type": "string", "description": "Required. Display name of the agent." }, "generatedSummary": { "type": "string", "description": "Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.", "readOnly": true }, "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" }, "name": { "type": "string", "description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`" }, "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" } }, "validationErrors": { "type": "array", "items": { "type": "string" }, "description": "Output only. Misconfigurations or errors in the agent that may affect agent quality.", "readOnly": true }, "beforeModelCallbacks": { "type": "array", "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." }, "tools": { "description": "Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "array", "items": { "type": "string" } }, "etag": { "type": "string", "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." }, "updateTime": { "readOnly": true, "description": "Output only. Timestamp when the agent was last updated.", "type": "string", "format": "google-datetime" }, "transferRules": { "type": "array", "items": { "$ref": "TransferRule" }, "description": "Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used." }, "afterAgentCallbacks": { "type": "array", "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." }, "modelSettings": { "$ref": "ModelSettings", "description": "Optional. Configurations for the LLM model." }, "instruction": { "description": "Optional. Instructions for the LLM model to guide the agent's behavior.", "type": "string" }, "beforeToolCallbacks": { "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", "items": { "$ref": "Callback" } }, "createTime": { "description": "Output only. Timestamp when the agent was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "toolsets": { "type": "array", "items": { "$ref": "AgentAgentToolset" }, "description": "Optional. List of toolsets for the agent." }, "childAgents": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`" }, "description": { "type": "string", "description": "Optional. Human-readable description of the agent." } }, "description": "An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks." }, "GuardrailLlmPromptSecurity": { "id": "GuardrailLlmPromptSecurity", "type": "object", "properties": { "defaultSettings": { "$ref": "GuardrailLlmPromptSecurityDefaultSecuritySettings", "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." }, "customPolicy": { "description": "Optional. Use a user-defined LlmPolicy to configure the security guardrail.", "$ref": "GuardrailLlmPolicy" }, "failOpen": { "type": "boolean", "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." } }, "description": "Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification." }, "ExportEvaluationRunsRequest": { "description": "Request message for EvaluationService.ExportEvaluationRuns.", "id": "ExportEvaluationRunsRequest", "type": "object", "properties": { "names": { "description": "Required. The resource names of the evaluation runs to export.", "type": "array", "items": { "type": "string" } }, "exportOptions": { "$ref": "ExportOptions", "description": "Optional. The export options for the evaluation runs." } } }, "EvaluationResultTaskCompletionResult": { "description": "The result of the task completion check for the conversation.", "id": "EvaluationResultTaskCompletionResult", "type": "object", "properties": { "score": { "format": "int32", "type": "integer", "description": "Output only. The task completion score. Can be -1, 0, 1", "readOnly": true }, "explanation": { "description": "Output only. The explanation for the task completion score.", "readOnly": true, "type": "string" }, "label": { "type": "string", "readOnly": true, "description": "Output only. The label associated with each score. Score 1: Task Completed Score 0: Task Not Completed Score -1: User Goal Undefined" } } }, "GenerateEvaluationRequest": { "description": "Request message for EvaluationService.GenerateEvaluation.", "id": "GenerateEvaluationRequest", "type": "object", "properties": { "source": { "type": "string", "description": "Optional. Indicate the source of the conversation. If not set, all sources will be searched.", "deprecated": 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." ], "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ] } } }, "AmbientSoundConfig": { "id": "AmbientSoundConfig", "type": "object", "properties": { "volumeGainDb": { "type": "number", "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." }, "prebuiltAmbientNoise": { "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`.", "deprecated": true, "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" }, "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" } }, "description": "Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation." }, "LfA2aV1SendMessageRequest": { "description": "Represents a request for the `SendMessage` method.", "id": "LfA2aV1SendMessageRequest", "type": "object", "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "A flexible key-value map for passing additional context or parameters." }, "message": { "$ref": "LfA2aV1Message", "description": "Required. The message to send to the agent." }, "configuration": { "description": "Configuration for the send request.", "$ref": "LfA2aV1SendMessageConfiguration" } } }, "GenerateAppResourceResponseTools": { "description": "The list of tools generated by the LLM assistant.", "id": "GenerateAppResourceResponseTools", "type": "object", "properties": { "tools": { "type": "array", "items": { "$ref": "Tool" }, "description": "The list of tools generated by the LLM assistant." } } }, "LatencyReportLlmCallLatency": { "description": "Latency metrics for a single LLM call.", "id": "LatencyReportLlmCallLatency", "type": "object", "properties": { "model": { "type": "string", "description": "Output only. The name of the model.", "readOnly": true }, "latencyMetrics": { "readOnly": true, "$ref": "LatencyReportLatencyMetrics", "description": "Output only. The latency metrics for the LLM call." } } }, "GenerateAppResourceResponseAppResources": { "id": "GenerateAppResourceResponseAppResources", "type": "object", "properties": { "evaluations": { "description": "The list of evaluations generated by the LLM assistant.", "type": "array", "items": { "$ref": "Evaluation" } }, "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." }, "TransferRule": { "description": "Rule for transferring to a specific agent.", "id": "TransferRule", "type": "object", "properties": { "childAgent": { "type": "string", "description": "Required. The resource name of the child agent the rule applies to. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`" }, "deterministicTransfer": { "description": "Optional. A rule that immediately transfers to the target agent when the condition is met.", "$ref": "TransferRuleDeterministicTransfer" }, "disablePlannerTransfer": { "$ref": "TransferRuleDisablePlannerTransfer", "description": "Optional. Rule that prevents the planner from transferring to the target agent." }, "direction": { "type": "string", "description": "Required. The direction of the transfer.", "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" ] } } }, "AggregatedMetricsToolMetrics": { "id": "AggregatedMetricsToolMetrics", "type": "object", "properties": { "passCount": { "description": "Output only. The number of times the tool passed.", "readOnly": true, "format": "int32", "type": "integer" }, "failCount": { "type": "integer", "format": "int32", "readOnly": true, "description": "Output only. The number of times the tool failed." }, "tool": { "description": "Output only. The name of the tool.", "readOnly": true, "type": "string" } }, "description": "Metrics for a single tool." }, "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.", "id": "GoogleSearchTool", "type": "object", "properties": { "contextUrls": { "description": "Optional. Content will be fetched directly from these URLs for context and grounding. Example: \"https://example.com/path.html\". A maximum of 20 URLs are allowed.", "type": "array", "items": { "type": "string" } }, "description": { "type": "string", "description": "Optional. Description of the tool's purpose." }, "promptConfig": { "$ref": "GoogleSearchToolPromptConfig", "description": "Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice." }, "preferredDomains": { "type": "array", "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." }, "name": { "description": "Required. The name of the tool.", "type": "string" }, "excludeDomains": { "description": "Optional. List of domains to be excluded from the search results. Example: \"example.com\". A maximum of 2000 domains can be excluded.", "type": "array", "items": { "type": "string" } } } }, "ExecuteToolResponse": { "id": "ExecuteToolResponse", "type": "object", "properties": { "tool": { "description": "The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "toolsetTool": { "description": "The toolset tool that got executed.", "$ref": "ToolsetTool" }, "response": { "description": "The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "variables": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "The variable values at the end of the tool execution." } }, "description": "Response message for ToolService.ExecuteTool." }, "GuardrailCodeCallback": { "description": "Guardrail that blocks the conversation based on the code callbacks provided.", "id": "GuardrailCodeCallback", "type": "object", "properties": { "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" }, "beforeModelCallback": { "$ref": "Callback", "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." }, "afterAgentCallback": { "$ref": "Callback", "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." }, "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" } } }, "DataStoreToolBoostSpecs": { "id": "DataStoreToolBoostSpecs", "type": "object", "properties": { "dataStores": { "description": "Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.", "type": "array", "items": { "type": "string" } }, "spec": { "type": "array", "items": { "$ref": "DataStoreToolBoostSpec" }, "description": "Required. A list of boosting specifications." } }, "description": "Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting." }, "QualityReportAgentIssues": { "description": "Issues identified for a single agent.", "id": "QualityReportAgentIssues", "type": "object", "properties": { "agent": { "type": "string", "description": "Optional. The name of the agent to which the issues are related. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`" }, "issues": { "description": "Optional. List of issues found for this agent.", "type": "array", "items": { "$ref": "QualityReportIssue" } } } }, "ImportAppRequest": { "description": "Request message for AgentService.ImportApp.", "id": "ImportAppRequest", "type": "object", "properties": { "ignoreAppLock": { "type": "boolean", "description": "Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock." }, "appId": { "type": "string", "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." }, "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" }, "importOptions": { "$ref": "ImportAppRequestImportOptions", "description": "Optional. Options governing the import process for the app." }, "displayName": { "type": "string", "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." }, "appContent": { "description": "Raw bytes representing the compressed zip file with the app folder structure.", "format": "byte", "type": "string" } } }, "EvaluationResultOverallToolInvocationResult": { "id": "EvaluationResultOverallToolInvocationResult", "type": "object", "properties": { "toolInvocationScore": { "description": "The overall tool invocation score for this turn. This indicates the overall percent of tools from the expected turn that were actually invoked.", "format": "float", "type": "number" }, "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 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" } }, "description": "The result of the overall tool invocation check." }, "TriggerAction": { "description": "Action that is taken when a certain precondition is met.", "id": "TriggerAction", "type": "object", "properties": { "generativeAnswer": { "description": "Optional. Respond with a generative answer.", "$ref": "TriggerActionGenerativeAnswer" }, "respondImmediately": { "description": "Optional. Immediately respond with a preconfigured response.", "$ref": "TriggerActionRespondImmediately" }, "transferAgent": { "description": "Optional. Transfer the conversation to a different agent.", "$ref": "TriggerActionTransferAgent" } } }, "PythonCodeCondition": { "description": "Python code block to evaluate the condition.", "id": "PythonCodeCondition", "type": "object", "properties": { "pythonCode": { "description": "Required. The python code to execute.", "type": "string" } } }, "AgentCard": { "id": "AgentCard", "type": "object", "properties": { "name": { "type": "string", "description": "Required. A human-readable name for the agent." }, "skills": { "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", "items": { "$ref": "AgentSkill" } }, "description": { "description": "Required. A description of the agent's domain of action/solution space.", "type": "string" }, "supportedInterfaces": { "type": "array", "items": { "$ref": "AgentInterface" }, "description": "Required. Ordered list of supported interfaces. The first entry is preferred." }, "version": { "type": "string", "description": "Required. The version of the agent." } }, "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" }, "UploadEvaluationAudioResponse": { "id": "UploadEvaluationAudioResponse", "type": "object", "properties": { "transcript": { "description": "The transcript of the audio, generated by Cloud Speech-to-Text.", "type": "string" }, "duration": { "description": "The duration of the audio.", "type": "string", "format": "google-duration" }, "audioGcsUri": { "type": "string", "description": "The Google Cloud Storage URI where the uploaded audio file is stored. Format: `gs:///`" } }, "description": "Response message for EvaluationService.UploadEvaluationAudio." }, "ConnectorToolset": { "id": "ConnectorToolset", "type": "object", "properties": { "connectorActions": { "type": "array", "items": { "$ref": "Action" }, "description": "Required. The list of connector actions/entity operations to generate tools for." }, "connection": { "type": "string", "description": "Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`" }, "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" } }, "description": "A toolset that generates tools from an Integration Connectors Connection." }, "Guardrail": { "description": "Guardrail contains a list of checks and balances to keep the agents safe and secure.", "id": "Guardrail", "type": "object", "properties": { "action": { "description": "Optional. Action to take when the guardrail is triggered.", "$ref": "TriggerAction" }, "displayName": { "description": "Required. Display name of the guardrail.", "type": "string" }, "name": { "type": "string", "description": "Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`" }, "modelSafety": { "description": "Optional. Guardrail that blocks the conversation if the LLM response is considered unsafe based on the model safety settings.", "$ref": "GuardrailModelSafety" }, "llmPromptSecurity": { "$ref": "GuardrailLlmPromptSecurity", "description": "Optional. Guardrail that blocks the conversation if the prompt is considered unsafe based on the LLM classification." }, "codeCallback": { "$ref": "GuardrailCodeCallback", "description": "Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution." }, "llmPolicy": { "$ref": "GuardrailLlmPolicy", "description": "Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification." }, "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" }, "contentFilter": { "description": "Optional. Guardrail that bans certain content from being used in the conversation.", "$ref": "GuardrailContentFilter" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the guardrail was last updated.", "readOnly": true }, "enabled": { "description": "Optional. Whether the guardrail is enabled.", "type": "boolean" }, "createTime": { "readOnly": true, "description": "Output only. Timestamp when the guardrail was created.", "type": "string", "format": "google-datetime" }, "description": { "type": "string", "description": "Optional. Description of the guardrail." } } }, "Citations": { "description": "Citations associated with the agent response.", "id": "Citations", "type": "object", "properties": { "citedChunks": { "description": "List of cited pieces of information.", "type": "array", "items": { "$ref": "CitationsCitedChunk" } } } }, "EndUserAuthConfig": { "description": "End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`.", "id": "EndUserAuthConfig", "type": "object", "properties": { "oauth2JwtBearerConfig": { "description": "JWT Profile Oauth 2.0 Authorization Grant authentication.", "$ref": "EndUserAuthConfigOauth2JwtBearerConfig" }, "oauth2AuthCodeConfig": { "description": "Oauth 2.0 Authorization Code authentication.", "$ref": "EndUserAuthConfigOauth2AuthCodeConfig" } } }, "GenerateAppResourceRequestHillClimbingFixConfig": { "id": "GenerateAppResourceRequestHillClimbingFixConfig", "type": "object", "properties": { "qualityReport": { "description": "Required. The quality report used to inform the instruction following fix.", "$ref": "QualityReport" } }, "description": "The configuration to be used for hill climbing fixes." }, "EvaluationResultScenarioExpectationOutcomeObservedToolCall": { "description": "The observed tool call and response.", "id": "EvaluationResultScenarioExpectationOutcomeObservedToolCall", "type": "object", "properties": { "toolCall": { "description": "Output only. The observed tool call.", "readOnly": true, "$ref": "ToolCall" }, "toolResponse": { "description": "Output only. The observed tool response.", "readOnly": true, "$ref": "ToolResponse" } } }, "ChannelProfilePersonaProperty": { "id": "ChannelProfilePersonaProperty", "type": "object", "properties": { "persona": { "type": "string", "description": "Optional. The persona of the channel.", "enumDescriptions": [ "UNKNOWN persona.", "The agent keeps the responses concise and to the point", "The agent provides additional context, explanations, and details" ], "enum": [ "UNKNOWN", "CONCISE", "CHATTY" ] } }, "description": "Represents the persona property of a channel." }, "ApiAuthentication": { "description": "Authentication information required for API calls.", "id": "ApiAuthentication", "type": "object", "properties": { "bearerTokenConfig": { "description": "Optional. Config for bearer token auth.", "$ref": "BearerTokenConfig" }, "apiKeyConfig": { "description": "Optional. Config for API key auth.", "$ref": "ApiKeyConfig" }, "serviceAccountAuthConfig": { "$ref": "ServiceAccountAuthConfig", "description": "Optional. Config for service account authentication." }, "oauthConfig": { "$ref": "OAuthConfig", "description": "Optional. Config for OAuth." }, "serviceAgentIdTokenAuthConfig": { "description": "Optional. Config for ID token auth generated from CES service agent.", "$ref": "ServiceAgentIdTokenAuthConfig" } } }, "RunSessionResponse": { "description": "Response message for SessionService.RunSession.", "id": "RunSessionResponse", "type": "object", "properties": { "outputs": { "type": "array", "items": { "$ref": "SessionOutput" }, "description": "Outputs for the session." } } }, "GenerateAppResourceResponseGenerateResultInfo": { "id": "GenerateAppResourceResponseGenerateResultInfo", "type": "object", "properties": { "explanation": { "type": "string", "description": "An explanation of the changes in the generated resource." } }, "description": "This provides additional information about the generated result." }, "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.", "id": "FileSearchTool", "type": "object", "properties": { "corpusType": { "enumDescriptions": [ "Unspecified corpus type.", "The corpus is created and owned by the user.", "The corpus is created by the agent." ], "enum": [ "CORPUS_TYPE_UNSPECIFIED", "USER_OWNED", "FULLY_MANAGED" ], "description": "Optional. The type of the corpus. Default is FULLY_MANAGED.", "type": "string" }, "name": { "type": "string", "description": "Required. The tool name." }, "description": { "description": "Optional. The tool description.", "type": "string" }, "fileCorpus": { "type": "string", "description": "Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}" } } }, "EvaluationScenarioUserFact": { "description": "Facts about the user as a key value pair.", "id": "EvaluationScenarioUserFact", "type": "object", "properties": { "name": { "type": "string", "description": "Required. The name of the user fact." }, "value": { "type": "string", "description": "Required. The value of the user fact." } } }, "RetrieveToolsResponse": { "description": "Response message for ToolService.RetrieveTools.", "id": "RetrieveToolsResponse", "type": "object", "properties": { "tools": { "type": "array", "items": { "$ref": "Tool" }, "description": "The list of tools that are included in the specified toolset." } } }, "DataStoreSettings": { "description": "Data store related settings for the app.", "id": "DataStoreSettings", "type": "object", "properties": { "engines": { "type": "array", "items": { "$ref": "DataStoreSettingsEngine" }, "description": "Output only. The engines for the app.", "readOnly": true } } }, "EvaluationPersona": { "id": "EvaluationPersona", "type": "object", "properties": { "description": { "description": "Optional. The description of the persona.", "type": "string" }, "speechConfig": { "$ref": "EvaluationPersonaSpeechConfig", "description": "Optional. Configuration for how the persona sounds (TTS settings)." }, "name": { "description": "Required. The unique identifier of the persona. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`", "type": "string" }, "displayName": { "type": "string", "description": "Required. The display name of the persona. Unique within an app." }, "personality": { "type": "string", "description": "Required. An instruction for the agent on how to behave in the evaluation." } }, "description": "A persona represents an end user in an evaluation." }, "ExecuteToolRequest": { "description": "Request message for ToolService.ExecuteTool.", "id": "ExecuteToolRequest", "type": "object", "properties": { "variables": { "description": "Optional. The variables that are available for the tool execution.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "tool": { "description": "Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}", "type": "string" }, "toolsetTool": { "description": "Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.", "$ref": "ToolsetTool" }, "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" }, "context": { "description": "Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "args": { "description": "Optional. The input parameters and values for the tool in JSON object format.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } } }, "EvaluationMetricsConfigSemanticSimilarityMetricsConfig": { "id": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig", "type": "object", "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." }, "OptimizationConfig": { "id": "OptimizationConfig", "type": "object", "properties": { "generateLossReport": { "type": "boolean", "description": "Optional. Whether to generate a loss report." }, "shouldSuggestFix": { "type": "boolean", "readOnly": true, "description": "Output only. Whether to suggest a fix for the losses." }, "errorMessage": { "type": "string", "description": "Output only. The error message if the optimization run failed.", "readOnly": true }, "status": { "type": "string", "description": "Output only. The status of the optimization run.", "readOnly": true, "enumDescriptions": [ "Optimization status is not specified.", "Optimization is running.", "Optimization has completed.", "Optimization failed due to an internal error." ], "enum": [ "OPTIMIZATION_STATUS_UNSPECIFIED", "RUNNING", "COMPLETED", "ERROR" ] }, "reportSummary": { "readOnly": true, "description": "Output only. The summary of the loss report.", "type": "string" }, "lossReport": { "description": "Output only. The generated loss report.", "readOnly": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "assistantSession": { "type": "string", "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}`", "readOnly": true } }, "description": "Configuration for running the optimization step after the evaluation run." }, "LatencyReportGuardrailLatency": { "id": "LatencyReportGuardrailLatency", "type": "object", "properties": { "guardrailDisplayName": { "type": "string", "readOnly": true, "description": "Output only. The display name of the guardrail." }, "guardrail": { "readOnly": true, "description": "Output only. The name of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`.", "type": "string" }, "latencyMetrics": { "readOnly": true, "$ref": "LatencyReportLatencyMetrics", "description": "Output only. The latency metrics for the guardrail." } }, "description": "Latency metrics for a single guardrail." }, "ListAppsResponse": { "id": "ListAppsResponse", "type": "object", "properties": { "unreachable": { "description": "Unordered list. Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "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" } }, "description": "Response message for AgentService.ListApps." }, "EvaluationResultEvaluationExpectationResult": { "id": "EvaluationResultEvaluationExpectationResult", "type": "object", "properties": { "prompt": { "readOnly": true, "description": "Output only. The prompt that was used for the evaluation.", "type": "string" }, "evaluationExpectation": { "readOnly": true, "description": "Output only. The evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`", "type": "string" }, "explanation": { "type": "string", "description": "Output only. The explanation for the result.", "readOnly": true }, "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 evaluation expectation.", "type": "string", "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ] } }, "description": "The result of a single evaluation expectation." }, "ListEvaluationResultsResponse": { "description": "Response message for EvaluationService.ListEvaluationResults.", "id": "ListEvaluationResultsResponse", "type": "object", "properties": { "evaluationResults": { "description": "The list of evaluation results.", "type": "array", "items": { "$ref": "EvaluationResult" } }, "nextPageToken": { "type": "string", "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." } } }, "ListEvaluationExpectationsResponse": { "description": "Response message for EvaluationService.ListEvaluationExpectations.", "id": "ListEvaluationExpectationsResponse", "type": "object", "properties": { "evaluationExpectations": { "type": "array", "items": { "$ref": "EvaluationExpectation" }, "description": "The list of evaluation expectations." }, "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" } } }, "ExportEvaluationResultsRequest": { "id": "ExportEvaluationResultsRequest", "type": "object", "properties": { "names": { "description": "Required. The resource names of the evaluation results to export.", "type": "array", "items": { "type": "string" } }, "exportOptions": { "$ref": "ExportOptions", "description": "Optional. The export options for the evaluation results." } }, "description": "Request message for EvaluationService.ExportEvaluationResults." }, "TriggerActionTransferAgent": { "id": "TriggerActionTransferAgent", "type": "object", "properties": { "agent": { "type": "string", "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}`" } }, "description": "The agent will transfer the conversation to a different agent." }, "ServiceDirectoryConfig": { "description": "Configuration for tools using Service Directory.", "id": "ServiceDirectoryConfig", "type": "object", "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" } } }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds": { "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds", "type": "object", "properties": { "toolInvocationParameterCorrectnessThreshold": { "format": "float", "type": "number", "description": "Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0." } }, "description": "Expectation level metrics thresholds." }, "PersonaRunConfig": { "description": "Configuration for running an evaluation for a specific persona.", "id": "PersonaRunConfig", "type": "object", "properties": { "persona": { "type": "string", "description": "Optional. The persona to use for the evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`" }, "taskCount": { "type": "integer", "format": "int32", "description": "Optional. The number of tasks to run for the persona." } } }, "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); }", "id": "Empty", "type": "object", "properties": {} }, "TestPersonaVoiceRequest": { "description": "Request message for EvaluationService.TestPersonaVoice.", "id": "TestPersonaVoiceRequest", "type": "object", "properties": { "personaId": { "description": "Required. The persona ID to test the voice for. Also accepts \"default\".", "type": "string" }, "text": { "type": "string", "description": "Required. The text to test the voice for." } } }, "BatchDeleteConversationsRequest": { "id": "BatchDeleteConversationsRequest", "type": "object", "properties": { "conversations": { "type": "array", "items": { "type": "string" }, "description": "Required. The resource names of the conversations to delete." } }, "description": "Request message for AgentService.BatchDeleteConversations." }, "LfA2aV1Message": { "id": "LfA2aV1Message", "type": "object", "properties": { "messageId": { "type": "string", "description": "Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator." }, "metadata": { "description": "Optional. Any metadata to provide along with the message.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "extensions": { "description": "The URIs of extensions that are present or contributed to this Message.", "type": "array", "items": { "type": "string" } }, "contextId": { "type": "string", "description": "Optional. The context id of the message. If set, the message will be associated with the given context." }, "referenceTaskIds": { "description": "A list of task IDs that this message references for additional context.", "type": "array", "items": { "type": "string" } }, "parts": { "description": "Required. Parts is the container of the message content.", "type": "array", "items": { "$ref": "LfA2aV1Part" } }, "taskId": { "type": "string", "description": "Optional. The task id of the message. If set, the message will be associated with the given task." }, "role": { "type": "string", "description": "Required. Identifies the sender of the message.", "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" ] } }, "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." }, "EvaluationResult": { "id": "EvaluationResult", "type": "object", "properties": { "persona": { "description": "Output only. The persona used to generate the conversation for the evaluation result.", "readOnly": true, "$ref": "EvaluationPersona" }, "displayName": { "type": "string", "description": "Required. Display name of the Evaluation Result. Unique within an Evaluation. By default, it has the following format: \" result - \"." }, "name": { "type": "string", "description": "Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`" }, "scenarioResult": { "readOnly": true, "$ref": "EvaluationResultScenarioResult", "description": "Output only. The outcome of a scenario evaluation." }, "initiatedBy": { "type": "string", "description": "Output only. The user who initiated the evaluation run that resulted in this result.", "readOnly": true }, "goldenResult": { "description": "Output only. The outcome of a golden evaluation.", "readOnly": true, "$ref": "EvaluationResultGoldenResult" }, "evaluationRun": { "description": "Output only. The evaluation run that produced this result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`", "readOnly": true, "type": "string" }, "appVersionDisplayName": { "type": "string", "description": "Output only. The display name of the `app_version` that the evaluation ran against.", "readOnly": true }, "error": { "description": "Output only. Deprecated: Use `error_info` instead. Errors encountered during execution.", "deprecated": true, "readOnly": true, "$ref": "Status" }, "createTime": { "description": "Output only. Timestamp when the evaluation result was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "evaluationMetricsThresholds": { "description": "Output only. The evaluation thresholds for the result.", "readOnly": true, "$ref": "EvaluationMetricsThresholds" }, "errorInfo": { "description": "Output only. Error information for the evaluation result.", "readOnly": true, "$ref": "EvaluationErrorInfo" }, "changelog": { "type": "string", "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." }, "changelogCreateTime": { "format": "google-datetime", "type": "string", "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.", "readOnly": true }, "config": { "description": "Output only. The configuration used in the evaluation run that resulted in this result.", "readOnly": true, "$ref": "EvaluationConfig" }, "goldenRunMethod": { "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ], "description": "Output only. The method used to run the golden evaluation.", "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." ], "type": "string" }, "appVersion": { "type": "string", "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}`", "readOnly": true }, "executionState": { "enum": [ "EXECUTION_STATE_UNSPECIFIED", "RUNNING", "COMPLETED", "ERROR" ], "type": "string", "readOnly": true, "enumDescriptions": [ "Evaluation result execution state is not specified.", "Evaluation result execution is running.", "Evaluation result execution has completed.", "Evaluation result execution failed due to an internal error." ], "description": "Output only. The state of the evaluation result execution." }, "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" } }, "description": "An evaluation result represents the output of running an Evaluation." }, "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec": { "id": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec", "type": "object", "properties": { "attributeType": { "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", "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`." ], "enum": [ "ATTRIBUTE_TYPE_UNSPECIFIED", "NUMERICAL", "FRESHNESS" ], "type": "string" }, "controlPoints": { "type": "array", "items": { "$ref": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, "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." }, "fieldName": { "description": "Optional. The name of the field whose value will be used to determine the boost amount.", "type": "string" }, "interpolationType": { "enumDescriptions": [ "Interpolation type is unspecified. In this case, it defaults to Linear.", "Piecewise linear interpolation will be applied." ], "enum": [ "INTERPOLATION_TYPE_UNSPECIFIED", "LINEAR" ], "description": "Optional. The interpolation type to be applied to connect the control points listed below.", "type": "string" } }, "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." }, "McpToolDefinition": { "description": "Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden.", "id": "McpToolDefinition", "type": "object", "properties": { "description": { "type": "string", "description": "Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`.", "readOnly": true }, "inputSchema": { "readOnly": true, "$ref": "Schema", "description": "Output only. The schema of the input arguments of the MCP tool." }, "outputSchema": { "readOnly": true, "$ref": "Schema", "description": "Output only. The schema of the output arguments of the MCP tool." } } }, "ListDeploymentsResponse": { "id": "ListDeploymentsResponse", "type": "object", "properties": { "nextPageToken": { "type": "string", "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." }, "deployments": { "type": "array", "items": { "$ref": "Deployment" }, "description": "The list of deployments." } }, "description": "Response message for AgentService.ListDeployments." }, "ExportEvaluationRunsResponse": { "id": "ExportEvaluationRunsResponse", "type": "object", "properties": { "evaluationRunsContent": { "format": "byte", "type": "string", "description": "The content of the exported Evaluation Runs. This will be populated if gcs_uri was not specified in the request." }, "evaluationRunsUri": { "type": "string", "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." } }, "description": "Response message for EvaluationService.ExportEvaluationRuns." }, "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.", "id": "GuardrailModelSafety", "type": "object", "properties": { "safetySettings": { "description": "Required. List of safety settings.", "type": "array", "items": { "$ref": "GuardrailModelSafetySafetySetting" } } } }, "ListEvaluationsResponse": { "description": "Response message for EvaluationService.ListEvaluations.", "id": "ListEvaluationsResponse", "type": "object", "properties": { "evaluations": { "type": "array", "items": { "$ref": "Evaluation" }, "description": "The list of evaluations." }, "nextPageToken": { "type": "string", "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." } } }, "GoogleSearchSuggestions": { "id": "GoogleSearchSuggestions", "type": "object", "properties": { "htmls": { "type": "array", "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)`." }, "webSearchQueries": { "type": "array", "items": { "$ref": "WebSearchQuery" }, "description": "List of queries used to perform the google search along with the search result URIs forming the search suggestions." } }, "description": "Search suggestions from Google Search Tool." }, "EvaluationConfig": { "description": "EvaluationConfig configures settings for running the evaluation.", "id": "EvaluationConfig", "type": "object", "properties": { "inputAudioConfig": { "description": "Optional. Configuration for processing the input audio.", "deprecated": true, "$ref": "InputAudioConfig" }, "toolCallBehaviour": { "enumDescriptions": [ "Unspecified tool call behavior. Will default to real tool calls.", "Use real tool calls.", "Use fake tool calls." ], "enum": [ "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED", "REAL", "FAKE" ], "description": "Optional. Specifies whether the evaluation should use real tool calls or fake tools.", "type": "string" }, "outputAudioConfig": { "description": "Optional. Configuration for generating the output audio.", "deprecated": true, "$ref": "OutputAudioConfig" }, "evaluationChannel": { "description": "Optional. The channel to evaluate.", "enumDescriptions": [ "Unspecified evaluation channel.", "Text-only evaluation channel.", "Audio evaluation channel." ], "enum": [ "EVALUATION_CHANNEL_UNSPECIFIED", "TEXT", "AUDIO" ], "type": "string" } } }, "ScheduledEvaluationRunSchedulingConfig": { "description": "Eval scheduling configuration details", "id": "ScheduledEvaluationRunSchedulingConfig", "type": "object", "properties": { "daysOfWeek": { "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", "items": { "type": "integer", "format": "int32" } }, "startTime": { "type": "string", "format": "google-datetime", "description": "Required. Timestamp when the eval should start." }, "frequency": { "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." ], "enum": [ "FREQUENCY_UNSPECIFIED", "NONE", "DAILY", "WEEKLY", "BIWEEKLY" ], "description": "Required. The frequency with which to run the eval", "type": "string" } } }, "EvaluationScenarioExpectationToolExpectation": { "id": "EvaluationScenarioExpectationToolExpectation", "type": "object", "properties": { "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" }, "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" } }, "description": "The tool call and response pair to be evaluated." }, "GenerateChatTokenRequest": { "id": "GenerateChatTokenRequest", "type": "object", "properties": { "recaptchaToken": { "type": "string", "description": "Optional. The reCAPTCHA token generated by the client-side chat widget." }, "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" } }, "description": "Request message for WidgetService.GenerateChatToken." }, "SessionOutput": { "description": "Output for the session.", "id": "SessionOutput", "type": "object", "properties": { "toolCalls": { "description": "Request for the client to execute the tools.", "$ref": "ToolCalls" }, "turnIndex": { "format": "int32", "type": "integer", "description": "Indicates the sequential order of conversation turn to which this output belongs to, starting from 1." }, "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" }, "audio": { "format": "byte", "type": "string", "description": "Output audio from the CES agent." }, "citations": { "description": "Citations that provide the source information for the agent's generated text.", "$ref": "Citations" }, "payload": { "description": "Custom payload with structured output from the CES agent.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "googleSearchSuggestions": { "$ref": "GoogleSearchSuggestions", "description": "The suggestions returned from Google Search as a result of invoking the GoogleSearchTool." }, "text": { "description": "Output text from the CES agent.", "type": "string" }, "endSession": { "$ref": "EndSession", "description": "Indicates the session has ended." }, "diagnosticInfo": { "$ref": "SessionOutputDiagnosticInfo", "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." } } }, "AggregatedMetricsHallucinationMetrics": { "description": "Metrics for hallucination results.", "id": "AggregatedMetricsHallucinationMetrics", "type": "object", "properties": { "score": { "format": "float", "type": "number", "description": "Output only. The average hallucination score (0 to 1).", "readOnly": true } } }, "CodeBlock": { "description": "A code block to be executed instead of a real tool call.", "id": "CodeBlock", "type": "object", "properties": { "pythonCode": { "type": "string", "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." } } }, "DataStoreToolBoostSpecConditionBoostSpec": { "description": "Boost specification for a condition.", "id": "DataStoreToolBoostSpecConditionBoostSpec", "type": "object", "properties": { "boost": { "type": "number", "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." }, "condition": { "type": "string", "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\"))" }, "boostControlSpec": { "description": "Optional. Complex specification for custom ranking based on customer defined attribute value.", "$ref": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec" } } }, "EvaluationResultScenarioExpectationOutcome": { "id": "EvaluationResultScenarioExpectationOutcome", "type": "object", "properties": { "observedToolCall": { "description": "Output only. The observed tool call.", "readOnly": true, "$ref": "EvaluationResultScenarioExpectationOutcomeObservedToolCall" }, "observedAgentResponse": { "description": "Output only. The observed agent response.", "readOnly": true, "$ref": "Message" }, "outcome": { "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "type": "string", "description": "Output only. The outcome of the ScenarioExpectation.", "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." ] }, "expectation": { "readOnly": true, "$ref": "EvaluationScenarioExpectation", "description": "Output only. The expectation that was evaluated." } }, "description": "The outcome of a scenario expectation." }, "EvaluationMetricsConfigGoldenMetricsConfig": { "id": "EvaluationMetricsConfigGoldenMetricsConfig", "type": "object", "properties": { "stepToolCorrectnessMetricsConfig": { "$ref": "EvaluationMetricsConfigToolCorrectnessMetricsConfig", "description": "Optional. Configuration for step level tool correctness metrics." }, "semanticSimilarityMetricsConfig": { "description": "Optional. Global configuration for semantic similarity metrics.", "$ref": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig" }, "toolCorrectnessMetricsConfig": { "description": "Optional. Configuration for turn level tool correctness metrics.", "$ref": "EvaluationMetricsConfigToolCorrectnessMetricsConfig" } }, "description": "Configuration for the golden metrics for the evaluation." }, "EvaluationMetricsConfigToolCorrectnessMetricsConfig": { "id": "EvaluationMetricsConfigToolCorrectnessMetricsConfig", "type": "object", "properties": { "enableToolCorrectnessMetrics": { "description": "Optional. Whether to calculate tool correctness metrics for the evaluation.", "type": "boolean" } }, "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." } }, "baseUrl": "https://ces.googleapis.com/" }