{
"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."
}
}
}
},
"basePath": "",
"baseUrl": "https://ces.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Customer Engagement Suite",
"description": "",
"discoveryVersion": "v1",
"documentationLink": "https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps",
"endpoints": [
{
"description": "Regional Endpoint",
"endpointUrl": "https://ces.us.rep.googleapis.com/",
"location": "us"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://ces.eu.rep.googleapis.com/",
"location": "eu"
}
],
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "ces:v1beta",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://ces.mtls.googleapis.com/",
"name": "ces",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getSecuritySettings": {
"description": "Retrieves the security settings for the project and location.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/securitySettings",
"httpMethod": "GET",
"id": "ces.projects.locations.getSecuritySettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the security settings to retrieve. Format: `projects/{project}/locations/{location}/securitySettings`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/securitySettings$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "SecuritySettings"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"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.",
"flatPath": "v1beta/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "ces.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"extraLocationTypes": {
"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.",
"location": "query",
"repeated": true,
"type": "string"
},
"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).",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/locations",
"response": {
"$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateSecuritySettings": {
"description": "Updates the security settings for the project and location.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/securitySettings",
"httpMethod": "PATCH",
"id": "ces.projects.locations.updateSecuritySettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/securitySettings$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "SecuritySettings"
},
"response": {
"$ref": "SecuritySettings"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"apps": {
"methods": {
"create": {
"description": "Creates a new app in the given project and location.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.create",
"parameterOrder": [
"parent"
],
"parameters": {
"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"
},
"parent": {
"description": "Required. The resource name of the location to create an app in.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/apps",
"request": {
"$ref": "App"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the specified app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. The current etag of the app. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app, deletion will be blocked and an ABORTED error will be returned.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The resource name of the app to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"executeTool": {
"description": "Executes the given tool with the given arguments.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:executeTool",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.executeTool",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}:executeTool",
"request": {
"$ref": "ExecuteToolRequest"
},
"response": {
"$ref": "ExecuteToolResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"exportApp": {
"description": "Exports the specified app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:exportApp",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.exportApp",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the app to export.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:exportApp",
"request": {
"$ref": "ExportAppRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"generateAppResource": {
"description": "Generates specific resources (e.g. agent) in the app using LLM assistant.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:generateAppResource",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.generateAppResource",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the app to generate the resource for.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}:generateAppResource",
"request": {
"$ref": "GenerateAppResourceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the app to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "App"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"importApp": {
"description": "Imports the specified app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps:importApp",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.importApp",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name with the location of the app to import.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/apps:importApp",
"request": {
"$ref": "ImportAppRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"importEvaluations": {
"description": "Imports evaluations into the app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:importEvaluations",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.importEvaluations",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The app to import the evaluations into. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}:importEvaluations",
"request": {
"$ref": "ImportEvaluationsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists apps in the given project and location.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter to be applied when listing the apps. See https://google.aip.dev/160 for more details.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list AgentService.ListApps call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the location to list apps from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/apps",
"response": {
"$ref": "ListAppsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the specified app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}",
"httpMethod": "PATCH",
"id": "ces.projects.locations.apps.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "App"
},
"response": {
"$ref": "App"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"retrieveToolSchema": {
"description": "Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:retrieveToolSchema",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.retrieveToolSchema",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}:retrieveToolSchema",
"request": {
"$ref": "RetrieveToolSchemaRequest"
},
"response": {
"$ref": "RetrieveToolSchemaResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"runEvaluation": {
"description": "Runs an evaluation of the app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:runEvaluation",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.runEvaluation",
"parameterOrder": [
"app"
],
"parameters": {
"app": {
"description": "Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+app}:runEvaluation",
"request": {
"$ref": "RunEvaluationRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testPersonaVoice": {
"description": "Tests the voice of a persona. Also accepts a default persona.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:testPersonaVoice",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.testPersonaVoice",
"parameterOrder": [
"app"
],
"parameters": {
"app": {
"description": "Required. the resource name of the app to test the persona voice for. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+app}:testPersonaVoice",
"request": {
"$ref": "TestPersonaVoiceRequest"
},
"response": {
"$ref": "TestPersonaVoiceResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"agents": {
"methods": {
"create": {
"description": "Creates a new agent in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.agents.create",
"parameterOrder": [
"parent"
],
"parameters": {
"agentId": {
"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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to create an agent in.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/agents",
"request": {
"$ref": "Agent"
},
"response": {
"$ref": "Agent"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the specified agent.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.agents.delete",
"parameterOrder": [
"name"
],
"parameters": {
"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"
},
"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": {
"description": "Required. The resource name of the agent to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified agent.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.agents.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the agent to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Agent"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists agents in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.agents.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list AgentService.ListAgents call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list agents from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/agents",
"response": {
"$ref": "ListAgentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the specified agent.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}",
"httpMethod": "PATCH",
"id": "ces.projects.locations.apps.agents.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "Agent"
},
"response": {
"$ref": "Agent"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"changelogs": {
"methods": {
"get": {
"description": "Gets the specified changelog.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs/{changelogsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.changelogs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the changelog to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/changelogs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Changelog"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists the changelogs of the specified app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.changelogs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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 > \"2025-01-01T00:00:00Z\"` * `create_time <= \"2025-01-01T00:00:00Z\" AND resource_type:tool`",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list AgentService.ListChangelogs call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list changelogs from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/changelogs",
"response": {
"$ref": "ListChangelogsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"conversations": {
"methods": {
"batchDelete": {
"description": "Batch deletes the specified conversations.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations:batchDelete",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.conversations.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/conversations:batchDelete",
"request": {
"$ref": "BatchDeleteConversationsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the specified conversation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.conversations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the conversation to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
},
"source": {
"deprecated": true,
"description": "Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.",
"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."
],
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"generateEvaluation": {
"description": "Creates a golden evaluation from a conversation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}:generateEvaluation",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.conversations.generateEvaluation",
"parameterOrder": [
"conversation"
],
"parameters": {
"conversation": {
"description": "Required. The conversation to create the golden evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+conversation}:generateEvaluation",
"request": {
"$ref": "GenerateEvaluationRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified conversation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.conversations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the conversation to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
},
"source": {
"deprecated": true,
"description": "Optional. Indicate the source of the conversation. If not set, all source will be searched.",
"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."
],
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Conversation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists conversations in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.conversations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter to be applied when listing the conversations. 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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list conversations from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
},
"source": {
"description": "Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of `sources` field.",
"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."
],
"location": "query",
"type": "string"
},
"sources": {
"description": "Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default.",
"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."
],
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/conversations",
"response": {
"$ref": "ListConversationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"deployments": {
"methods": {
"create": {
"description": "Creates a new deployment in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.deployments.create",
"parameterOrder": [
"parent"
],
"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}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/deployments",
"request": {
"$ref": "Deployment"
},
"response": {
"$ref": "Deployment"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the specified deployment.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.deployments.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"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.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the deployment to delete. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified deployment.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.deployments.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Deployment"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists deployments in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.deployments.list",
"parameterOrder": [
"parent"
],
"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"
},
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeployments` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/deployments",
"response": {
"$ref": "ListDeploymentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the specified deployment.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}",
"httpMethod": "PATCH",
"id": "ces.projects.locations.apps.deployments.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The list of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "Deployment"
},
"response": {
"$ref": "Deployment"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"evaluationDatasets": {
"methods": {
"create": {
"description": "Creates an evaluation dataset.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.evaluationDatasets.create",
"parameterOrder": [
"parent"
],
"parameters": {
"evaluationDatasetId": {
"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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/evaluationDatasets",
"request": {
"$ref": "EvaluationDataset"
},
"response": {
"$ref": "EvaluationDataset"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an evaluation dataset.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.evaluationDatasets.delete",
"parameterOrder": [
"name"
],
"parameters": {
"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"
},
"name": {
"description": "Required. The resource name of the evaluation dataset to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified evaluation dataset.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.evaluationDatasets.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the evaluation dataset to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "EvaluationDataset"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all evaluation datasets in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.evaluationDatasets.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter to be applied when listing the evaluation datasets. See https://google.aip.dev/160 for more details.",
"location": "query",
"type": "string"
},
"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.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationDatasets call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list evaluation datasets from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/evaluationDatasets",
"response": {
"$ref": "ListEvaluationDatasetsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates an evaluation dataset.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}",
"httpMethod": "PATCH",
"id": "ces.projects.locations.apps.evaluationDatasets.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The unique identifier of this evaluation dataset. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "EvaluationDataset"
},
"response": {
"$ref": "EvaluationDataset"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"evaluationExpectations": {
"methods": {
"create": {
"description": "Creates an evaluation expectation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.evaluationExpectations.create",
"parameterOrder": [
"parent"
],
"parameters": {
"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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The app to create the evaluation expectation for. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/evaluationExpectations",
"request": {
"$ref": "EvaluationExpectation"
},
"response": {
"$ref": "EvaluationExpectation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an evaluation expectation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.evaluationExpectations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"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.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The resource name of the evaluation expectation to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified evaluation expectation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.evaluationExpectations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the evaluation expectation to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "EvaluationExpectation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all evaluation expectations in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.evaluationExpectations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter to be applied when listing the evaluation expectations. See https://google.aip.dev/160 for more details.",
"location": "query",
"type": "string"
},
"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.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationExpectations call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list evaluation expectations from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/evaluationExpectations",
"response": {
"$ref": "ListEvaluationExpectationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates an evaluation expectation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}",
"httpMethod": "PATCH",
"id": "ces.projects.locations.apps.evaluationExpectations.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The unique identifier of this evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "EvaluationExpectation"
},
"response": {
"$ref": "EvaluationExpectation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"evaluationRuns": {
"methods": {
"delete": {
"description": "Deletes an evaluation run.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns/{evaluationRunsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.evaluationRuns.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the evaluation run to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationRuns/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified evaluation run.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns/{evaluationRunsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.evaluationRuns.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the evaluation run to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationRuns/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "EvaluationRun"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all evaluation runs in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.evaluationRuns.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter to be applied when listing the evaluation runs. See https://google.aip.dev/160 for more details.",
"location": "query",
"type": "string"
},
"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.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationRuns call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list evaluation runs from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/evaluationRuns",
"response": {
"$ref": "ListEvaluationRunsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"evaluations": {
"methods": {
"create": {
"description": "Creates an evaluation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.evaluations.create",
"parameterOrder": [
"parent"
],
"parameters": {
"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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/evaluations",
"request": {
"$ref": "Evaluation"
},
"response": {
"$ref": "Evaluation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an evaluation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.evaluations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"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"
},
"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": {
"description": "Required. The resource name of the evaluation to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"export": {
"description": "Exports evaluations.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations:export",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.evaluations.export",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the app to export evaluations from. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/evaluations:export",
"request": {
"$ref": "ExportEvaluationsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified evaluation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.evaluations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the evaluation to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Evaluation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all evaluations in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.evaluations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"evaluationFilter": {
"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",
"location": "query",
"type": "string"
},
"evaluationRunFilter": {
"description": "Optional. Filter string for fields on the associated EvaluationRun resources. See https://google.aip.dev/160 for more details. Supported fields: create_time, initiated_by, app_version_display_name",
"location": "query",
"type": "string"
},
"filter": {
"deprecated": true,
"description": "Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.",
"location": "query",
"type": "string"
},
"lastTenResults": {
"description": "Optional. Whether to include the last 10 evaluation results for each evaluation in the response.",
"location": "query",
"type": "boolean"
},
"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.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list evaluations from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/evaluations",
"response": {
"$ref": "ListEvaluationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates an evaluation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}",
"httpMethod": "PATCH",
"id": "ces.projects.locations.apps.evaluations.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The unique identifier of this evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "Evaluation"
},
"response": {
"$ref": "Evaluation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"uploadEvaluationAudio": {
"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.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}:uploadEvaluationAudio",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.evaluations.uploadEvaluationAudio",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Evaluation for which to upload the evaluation audio. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:uploadEvaluationAudio",
"request": {
"$ref": "UploadEvaluationAudioRequest"
},
"response": {
"$ref": "UploadEvaluationAudioResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"results": {
"methods": {
"delete": {
"description": "Deletes an evaluation result.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.evaluations.results.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the evaluation result to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified evaluation result.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.evaluations.results.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the evaluation result to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "EvaluationResult"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all evaluation results for a given evaluation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.evaluations.results.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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"
},
"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.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationResults call.",
"location": "query",
"type": "string"
},
"parent": {
"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/-`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/results",
"response": {
"$ref": "ListEvaluationResultsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"examples": {
"methods": {
"create": {
"description": "Creates a new example in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.examples.create",
"parameterOrder": [
"parent"
],
"parameters": {
"exampleId": {
"description": "Optional. The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to create an example in.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/examples",
"request": {
"$ref": "Example"
},
"response": {
"$ref": "Example"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the specified example.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.examples.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. The current etag of the example. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the example, deletion will be blocked and an ABORTED error will be returned.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The resource name of the example to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified example.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.examples.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the example to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Example"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists examples in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.examples.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list AgentService.ListExamples call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list examples from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/examples",
"response": {
"$ref": "ListExamplesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the specified example.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}",
"httpMethod": "PATCH",
"id": "ces.projects.locations.apps.examples.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "Example"
},
"response": {
"$ref": "Example"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"guardrails": {
"methods": {
"create": {
"description": "Creates a new guardrail in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.guardrails.create",
"parameterOrder": [
"parent"
],
"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": {
"description": "Required. The resource name of the app to create a guardrail in.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/guardrails",
"request": {
"$ref": "Guardrail"
},
"response": {
"$ref": "Guardrail"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the specified guardrail.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.guardrails.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. The current etag of the guardrail. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the guardrail, deletion will be blocked and an ABORTED error will be returned.",
"location": "query",
"type": "string"
},
"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.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The resource name of the guardrail to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified guardrail.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.guardrails.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the guardrail to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Guardrail"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists guardrails in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.guardrails.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter to be applied when listing the guardrails. See https://google.aip.dev/160 for more details.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list AgentService.ListGuardrails call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list guardrails from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/guardrails",
"response": {
"$ref": "ListGuardrailsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the specified guardrail.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}",
"httpMethod": "PATCH",
"id": "ces.projects.locations.apps.guardrails.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "Guardrail"
},
"response": {
"$ref": "Guardrail"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"scheduledEvaluationRuns": {
"methods": {
"create": {
"description": "Creates a scheduled evaluation run.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.scheduledEvaluationRuns.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The app to create the scheduled evaluation run for. Format: `projects/{project}/locations/{location}/apps/{app}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
},
"scheduledEvaluationRunId": {
"description": "Optional. The ID to use for the scheduled evaluation run, which will become the final component of the scheduled evaluation run's resource name. If not provided, a unique ID will be automatically assigned.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+parent}/scheduledEvaluationRuns",
"request": {
"$ref": "ScheduledEvaluationRun"
},
"response": {
"$ref": "ScheduledEvaluationRun"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a scheduled evaluation run.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.scheduledEvaluationRuns.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. The etag of the ScheduledEvaluationRun. If provided, it must match the server's etag.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The resource name of the scheduled evaluation run to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified scheduled evaluation run.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.scheduledEvaluationRuns.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the scheduled evaluation run to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "ScheduledEvaluationRun"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all scheduled evaluation runs in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.scheduledEvaluationRuns.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"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",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field to sort by. Supported fields are: \"name\" (ascending), \"create_time\" (descending), \"update_time\" (descending), \"next_scheduled_execution\" (ascending), and \"last_completed_run.create_time\" (descending). If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListScheduledEvaluationRuns call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list scheduled evaluation runs from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/scheduledEvaluationRuns",
"response": {
"$ref": "ListScheduledEvaluationRunsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a scheduled evaluation run.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}",
"httpMethod": "PATCH",
"id": "ces.projects.locations.apps.scheduledEvaluationRuns.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "ScheduledEvaluationRun"
},
"response": {
"$ref": "ScheduledEvaluationRun"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"sessions": {
"methods": {
"generateChatToken": {
"description": "Generates a session scoped token for chat widget to authenticate with Session APIs.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:generateChatToken",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.sessions.generateChatToken",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:generateChatToken",
"request": {
"$ref": "GenerateChatTokenRequest"
},
"response": {
"$ref": "GenerateChatTokenResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"runSession": {
"description": "Initiates a single-turn interaction with the CES agent within a session.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:runSession",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.sessions.runSession",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+session}:runSession",
"request": {
"$ref": "RunSessionRequest"
},
"response": {
"$ref": "RunSessionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"streamRunSession": {
"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.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:streamRunSession",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.sessions.streamRunSession",
"parameterOrder": [
"session"
],
"parameters": {
"session": {
"description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+session}:streamRunSession",
"request": {
"$ref": "RunSessionRequest"
},
"response": {
"$ref": "RunSessionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"tools": {
"methods": {
"create": {
"description": "Creates a new tool in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.tools.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the app to create a tool in.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
},
"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.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+parent}/tools",
"request": {
"$ref": "Tool"
},
"response": {
"$ref": "Tool"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the specified tool.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.tools.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"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.",
"location": "query",
"type": "string"
},
"force": {
"description": "Optional. Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples. * If `force = false`, the deletion will fail if any agents still reference the tool. * If `force = true`, all existing references from agents will be removed and the tool will be deleted.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The resource name of the tool to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified tool.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.tools.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the tool to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Tool"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists tools in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.tools.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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"
},
"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. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list AgentService.ListTools call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list tools from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/tools",
"response": {
"$ref": "ListToolsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the specified tool.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}",
"httpMethod": "PATCH",
"id": "ces.projects.locations.apps.tools.patch",
"parameterOrder": [
"name"
],
"parameters": {
"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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "Tool"
},
"response": {
"$ref": "Tool"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"toolsets": {
"methods": {
"create": {
"description": "Creates a new toolset in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.toolsets.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the app to create a toolset in.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
},
"toolsetId": {
"description": "Optional. The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+parent}/toolsets",
"request": {
"$ref": "Toolset"
},
"response": {
"$ref": "Toolset"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the specified toolset.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.toolsets.delete",
"parameterOrder": [
"name"
],
"parameters": {
"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.",
"location": "query",
"type": "string"
},
"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"
},
"name": {
"description": "Required. The resource name of the toolset to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified toolset.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.toolsets.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the toolset to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Toolset"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists toolsets in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.toolsets.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter to be applied when listing the toolsets. See https://google.aip.dev/160 for more details.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list AgentService.ListToolsets call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list toolsets from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/toolsets",
"response": {
"$ref": "ListToolsetsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the specified toolset.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}",
"httpMethod": "PATCH",
"id": "ces.projects.locations.apps.toolsets.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "Toolset"
},
"response": {
"$ref": "Toolset"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"retrieveTools": {
"description": "Retrieve the list of tools included in the specified toolset.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}:retrieveTools",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.toolsets.retrieveTools",
"parameterOrder": [
"toolset"
],
"parameters": {
"toolset": {
"description": "Required. The name of the toolset to retrieve the tools for. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+toolset}:retrieveTools",
"request": {
"$ref": "RetrieveToolsRequest"
},
"response": {
"$ref": "RetrieveToolsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"versions": {
"methods": {
"create": {
"description": "Creates a new app version in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.versions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to create an app version in.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/versions",
"request": {
"$ref": "AppVersion"
},
"response": {
"$ref": "AppVersion"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the specified app version.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.apps.versions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. The current etag of the app version. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app version, deletion will be blocked and an ABORTED error will be returned.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The resource name of the app version to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of the specified app version.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.versions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the app version to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "AppVersion"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all app versions in the given app.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions",
"httpMethod": "GET",
"id": "ces.projects.locations.apps.versions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter to be applied when listing the app versions. See https://google.aip.dev/160 for more details.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous list AgentService.ListAppVersions call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the app to list app versions from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/versions",
"response": {
"$ref": "ListAppVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"restore": {
"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.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}:restore",
"httpMethod": "POST",
"id": "ces.projects.locations.apps.versions.restore",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the app version to restore.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:restore",
"request": {
"$ref": "RestoreAppVersionRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"operations": {
"methods": {
"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`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "ces.projects.locations.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"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`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "ces.projects.locations.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"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.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "ces.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "ces.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"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"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20260422",
"rootUrl": "https://ces.googleapis.com/",
"schemas": {
"Action": {
"description": "Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details.",
"id": "Action",
"properties": {
"connectionActionId": {
"description": "ID of a Connection action for the tool to use.",
"type": "string"
},
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"outputFields": {
"description": "Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ActionEntityOperation": {
"description": "Entity CRUD operation specification.",
"id": "ActionEntityOperation",
"properties": {
"entityId": {
"description": "Required. ID of the entity.",
"type": "string"
},
"operation": {
"description": "Required. Operation to perform on the entity.",
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"LIST",
"GET",
"CREATE",
"UPDATE",
"DELETE"
],
"enumDescriptions": [
"Operation type unspecified. Invalid, ConnectorTool create/update will fail.",
"List operation.",
"Get operation.",
"Create operation.",
"Update operation.",
"Delete operation."
],
"type": "string"
}
},
"type": "object"
},
"Agent": {
"description": "An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks.",
"id": "Agent",
"properties": {
"afterAgentCallbacks": {
"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.",
"items": {
"$ref": "Callback"
},
"type": "array"
},
"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.",
"items": {
"$ref": "Callback"
},
"type": "array"
},
"afterToolCallbacks": {
"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.",
"items": {
"$ref": "Callback"
},
"type": "array"
},
"beforeAgentCallbacks": {
"description": "Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.",
"items": {
"$ref": "Callback"
},
"type": "array"
},
"beforeModelCallbacks": {
"description": "Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.",
"items": {
"$ref": "Callback"
},
"type": "array"
},
"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.",
"items": {
"$ref": "Callback"
},
"type": "array"
},
"childAgents": {
"description": "Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
"items": {
"type": "string"
},
"type": "array"
},
"createTime": {
"description": "Output only. Timestamp when the agent was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Human-readable description of the agent.",
"type": "string"
},
"displayName": {
"description": "Required. Display name of the agent.",
"type": "string"
},
"etag": {
"description": "Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.",
"type": "string"
},
"generatedSummary": {
"description": "Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.",
"readOnly": true,
"type": "string"
},
"guardrails": {
"description": "Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`",
"items": {
"type": "string"
},
"type": "array"
},
"instruction": {
"description": "Optional. Instructions for the LLM model to guide the agent's behavior.",
"type": "string"
},
"llmAgent": {
"$ref": "AgentLlmAgent",
"description": "Optional. The default agent type."
},
"modelSettings": {
"$ref": "ModelSettings",
"description": "Optional. Configurations for the LLM model."
},
"name": {
"description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
"type": "string"
},
"remoteDialogflowAgent": {
"$ref": "AgentRemoteDialogflowAgent",
"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`."
},
"tools": {
"description": "Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`",
"items": {
"type": "string"
},
"type": "array"
},
"toolsets": {
"description": "Optional. List of toolsets for the agent.",
"items": {
"$ref": "AgentAgentToolset"
},
"type": "array"
},
"transferRules": {
"description": "Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.",
"items": {
"$ref": "TransferRule"
},
"type": "array"
},
"updateTime": {
"description": "Output only. Timestamp when the agent was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AgentAgentToolset": {
"description": "A toolset with a selection of its tools.",
"id": "AgentAgentToolset",
"properties": {
"toolIds": {
"description": "Optional. The tools IDs to filter the toolset.",
"items": {
"type": "string"
},
"type": "array"
},
"toolset": {
"description": "Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`",
"type": "string"
}
},
"type": "object"
},
"AgentLlmAgent": {
"description": "Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.",
"id": "AgentLlmAgent",
"properties": {},
"type": "object"
},
"AgentRemoteDialogflowAgent": {
"description": "The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent.",
"id": "AgentRemoteDialogflowAgent",
"properties": {
"agent": {
"description": "Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`",
"type": "string"
},
"environmentId": {
"description": "Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.",
"type": "string"
},
"flowId": {
"description": "Optional. The flow ID of the flow in the Dialogflow agent.",
"type": "string"
},
"inputVariableMapping": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.",
"type": "object"
},
"outputVariableMapping": {
"additionalProperties": {
"type": "string"
},
"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"
},
"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"
}
},
"type": "object"
},
"AgentTool": {
"description": "Represents a tool that allows the agent to call another agent.",
"id": "AgentTool",
"properties": {
"agent": {
"description": "Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`",
"type": "string"
},
"description": {
"description": "Optional. Description of the tool's purpose.",
"type": "string"
},
"name": {
"description": "Required. The name of the agent tool.",
"type": "string"
},
"rootAgent": {
"deprecated": true,
"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}`",
"type": "string"
}
},
"type": "object"
},
"AgentTransfer": {
"description": "Represents an event indicating the transfer of a conversation to a different agent.",
"id": "AgentTransfer",
"properties": {
"displayName": {
"description": "Output only. Display name of the agent.",
"readOnly": true,
"type": "string"
},
"targetAgent": {
"description": "Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
"type": "string"
}
},
"type": "object"
},
"AggregatedMetrics": {
"description": "Aggregated metrics for an evaluation or evaluation dataset.",
"id": "AggregatedMetrics",
"properties": {
"metricsByAppVersion": {
"description": "Output only. Aggregated metrics, grouped by app version ID.",
"items": {
"$ref": "AggregatedMetricsMetricsByAppVersion"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"AggregatedMetricsHallucinationMetrics": {
"description": "Metrics for hallucination results.",
"id": "AggregatedMetricsHallucinationMetrics",
"properties": {
"score": {
"description": "Output only. The average hallucination score (0 to 1).",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"AggregatedMetricsMetricsByAppVersion": {
"description": "Metrics aggregated per app version.",
"id": "AggregatedMetricsMetricsByAppVersion",
"properties": {
"appVersionId": {
"description": "Output only. The app version ID.",
"readOnly": true,
"type": "string"
},
"failCount": {
"description": "Output only. The number of times the evaluation failed.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"hallucinationMetrics": {
"description": "Output only. Metrics for hallucination within this app version.",
"items": {
"$ref": "AggregatedMetricsHallucinationMetrics"
},
"readOnly": true,
"type": "array"
},
"metricsByTurn": {
"description": "Output only. Metrics aggregated per turn within this app version.",
"items": {
"$ref": "AggregatedMetricsMetricsByTurn"
},
"readOnly": true,
"type": "array"
},
"passCount": {
"description": "Output only. The number of times the evaluation passed.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"semanticSimilarityMetrics": {
"description": "Output only. Metrics for semantic similarity within this app version.",
"items": {
"$ref": "AggregatedMetricsSemanticSimilarityMetrics"
},
"readOnly": true,
"type": "array"
},
"toolCallLatencyMetrics": {
"description": "Output only. Metrics for tool call latency within this app version.",
"items": {
"$ref": "AggregatedMetricsToolCallLatencyMetrics"
},
"readOnly": true,
"type": "array"
},
"toolMetrics": {
"description": "Output only. Metrics for each tool within this app version.",
"items": {
"$ref": "AggregatedMetricsToolMetrics"
},
"readOnly": true,
"type": "array"
},
"turnLatencyMetrics": {
"description": "Output only. Metrics for turn latency within this app version.",
"items": {
"$ref": "AggregatedMetricsTurnLatencyMetrics"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"AggregatedMetricsMetricsByTurn": {
"description": "Metrics aggregated per turn.",
"id": "AggregatedMetricsMetricsByTurn",
"properties": {
"hallucinationMetrics": {
"description": "Output only. Metrics for hallucination within this turn.",
"items": {
"$ref": "AggregatedMetricsHallucinationMetrics"
},
"readOnly": true,
"type": "array"
},
"semanticSimilarityMetrics": {
"description": "Output only. Metrics for semantic similarity within this turn.",
"items": {
"$ref": "AggregatedMetricsSemanticSimilarityMetrics"
},
"readOnly": true,
"type": "array"
},
"toolCallLatencyMetrics": {
"description": "Output only. Metrics for tool call latency within this turn.",
"items": {
"$ref": "AggregatedMetricsToolCallLatencyMetrics"
},
"readOnly": true,
"type": "array"
},
"toolMetrics": {
"description": "Output only. Metrics for each tool within this turn.",
"items": {
"$ref": "AggregatedMetricsToolMetrics"
},
"readOnly": true,
"type": "array"
},
"turnIndex": {
"description": "Output only. The turn index (0-based).",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"turnLatencyMetrics": {
"description": "Output only. Metrics for turn latency within this turn.",
"items": {
"$ref": "AggregatedMetricsTurnLatencyMetrics"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"AggregatedMetricsSemanticSimilarityMetrics": {
"description": "Metrics for semantic similarity results.",
"id": "AggregatedMetricsSemanticSimilarityMetrics",
"properties": {
"score": {
"description": "Output only. The average semantic similarity score (0-4).",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"AggregatedMetricsToolCallLatencyMetrics": {
"description": "Metrics for tool call latency.",
"id": "AggregatedMetricsToolCallLatencyMetrics",
"properties": {
"averageLatency": {
"description": "Output only. The average latency of the tool calls.",
"format": "google-duration",
"readOnly": true,
"type": "string"
},
"tool": {
"description": "Output only. The name of the tool.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AggregatedMetricsToolMetrics": {
"description": "Metrics for a single tool.",
"id": "AggregatedMetricsToolMetrics",
"properties": {
"failCount": {
"description": "Output only. The number of times the tool failed.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"passCount": {
"description": "Output only. The number of times the tool passed.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"tool": {
"description": "Output only. The name of the tool.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AggregatedMetricsTurnLatencyMetrics": {
"description": "Metrics for turn latency.",
"id": "AggregatedMetricsTurnLatencyMetrics",
"properties": {
"averageLatency": {
"description": "Output only. The average latency of the turns.",
"format": "google-duration",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AmbientSoundConfig": {
"description": "Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.",
"id": "AmbientSoundConfig",
"properties": {
"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"
},
"prebuiltAmbientNoise": {
"deprecated": true,
"description": "Optional. Deprecated: `prebuilt_ambient_noise` is deprecated in favor of `prebuilt_ambient_sound`.",
"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."
],
"type": "string"
},
"prebuiltAmbientSound": {
"description": "Optional. Name of the prebuilt ambient sound. Valid values are: - \"coffee_shop\" - \"keyboard\" - \"keypad\" - \"hum\" - \"office_1\" - \"office_2\" - \"office_3\" - \"room_1\" - \"room_2\" - \"room_3\" - \"room_4\" - \"room_5\" - \"air_conditioner\"",
"type": "string"
},
"volumeGainDb": {
"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.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"ApiAuthentication": {
"description": "Authentication information required for API calls.",
"id": "ApiAuthentication",
"properties": {
"apiKeyConfig": {
"$ref": "ApiKeyConfig",
"description": "Optional. Config for API key auth."
},
"bearerTokenConfig": {
"$ref": "BearerTokenConfig",
"description": "Optional. Config for bearer token auth."
},
"oauthConfig": {
"$ref": "OAuthConfig",
"description": "Optional. Config for OAuth."
},
"serviceAccountAuthConfig": {
"$ref": "ServiceAccountAuthConfig",
"description": "Optional. Config for service account authentication."
},
"serviceAgentIdTokenAuthConfig": {
"$ref": "ServiceAgentIdTokenAuthConfig",
"description": "Optional. Config for ID token auth generated from CES service agent."
}
},
"type": "object"
},
"ApiKeyConfig": {
"description": "Configurations for authentication with API key.",
"id": "ApiKeyConfig",
"properties": {
"apiKeySecretVersion": {
"description": "Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.",
"type": "string"
},
"keyName": {
"description": "Required. The parameter name or the header name of the API key. E.g., If the API request is \"https://example.com/act?X-Api-Key=\", \"X-Api-Key\" would be the parameter name.",
"type": "string"
},
"requestLocation": {
"description": "Required. Key location in the request.",
"enum": [
"REQUEST_LOCATION_UNSPECIFIED",
"HEADER",
"QUERY_STRING"
],
"enumDescriptions": [
"Unspecified. This value should not be used.",
"Represents the key in http header.",
"Represents the key in query string."
],
"type": "string"
}
},
"type": "object"
},
"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",
"properties": {
"audioProcessingConfig": {
"$ref": "AudioProcessingConfig",
"description": "Optional. Audio processing configuration of the app."
},
"clientCertificateSettings": {
"$ref": "ClientCertificateSettings",
"description": "Optional. The default client certificate settings for the app."
},
"createTime": {
"description": "Output only. Timestamp when the app was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataStoreSettings": {
"$ref": "DataStoreSettings",
"description": "Optional. The data store settings for the app."
},
"defaultChannelProfile": {
"$ref": "ChannelProfile",
"description": "Optional. The default channel profile used by the app."
},
"deploymentCount": {
"description": "Output only. Number of deployments in the app.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"description": {
"description": "Optional. Human-readable description of the app.",
"type": "string"
},
"displayName": {
"description": "Required. Display name of the app.",
"type": "string"
},
"errorHandlingSettings": {
"$ref": "ErrorHandlingSettings",
"description": "Optional. Error handling settings of the app."
},
"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"
},
"evaluationMetricsThresholds": {
"$ref": "EvaluationMetricsThresholds",
"description": "Optional. The evaluation thresholds for 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.",
"items": {
"$ref": "EvaluationPersona"
},
"type": "array"
},
"evaluationSettings": {
"$ref": "EvaluationSettings",
"description": "Optional. The evaluation settings for the app."
},
"globalInstruction": {
"description": "Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.",
"type": "string"
},
"guardrails": {
"description": "Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`",
"items": {
"type": "string"
},
"type": "array"
},
"languageSettings": {
"$ref": "LanguageSettings",
"description": "Optional. Language settings of the app."
},
"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"
},
"loggingSettings": {
"$ref": "LoggingSettings",
"description": "Optional. Logging settings of the app."
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.",
"type": "object"
},
"modelSettings": {
"$ref": "ModelSettings",
"description": "Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed."
},
"name": {
"description": "Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`",
"type": "string"
},
"pinned": {
"description": "Optional. Whether the app is pinned in the app list.",
"type": "boolean"
},
"predefinedVariableDeclarations": {
"description": "Output only. The declarations of predefined variables for the app.",
"items": {
"$ref": "AppVariableDeclaration"
},
"readOnly": true,
"type": "array"
},
"rootAgent": {
"description": "Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
"type": "string"
},
"timeZoneSettings": {
"$ref": "TimeZoneSettings",
"description": "Optional. TimeZone settings of the app."
},
"toolExecutionMode": {
"description": "Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.",
"enum": [
"TOOL_EXECUTION_MODE_UNSPECIFIED",
"PARALLEL",
"SEQUENTIAL"
],
"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."
],
"type": "string"
},
"updateTime": {
"description": "Output only. Timestamp when the app was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"variableDeclarations": {
"description": "Optional. The declarations of the variables.",
"items": {
"$ref": "AppVariableDeclaration"
},
"type": "array"
}
},
"type": "object"
},
"AppSnapshot": {
"description": "A snapshot of the app.",
"id": "AppSnapshot",
"properties": {
"agents": {
"description": "Optional. List of agents in the app.",
"items": {
"$ref": "Agent"
},
"type": "array"
},
"app": {
"$ref": "App",
"description": "Optional. The basic settings for the app."
},
"examples": {
"description": "Optional. List of examples in the app.",
"items": {
"$ref": "Example"
},
"type": "array"
},
"guardrails": {
"description": "Optional. List of guardrails in the app.",
"items": {
"$ref": "Guardrail"
},
"type": "array"
},
"tools": {
"description": "Optional. List of tools in the app.",
"items": {
"$ref": "Tool"
},
"type": "array"
},
"toolsets": {
"description": "Optional. List of toolsets in the app.",
"items": {
"$ref": "Toolset"
},
"type": "array"
}
},
"type": "object"
},
"AppVariableDeclaration": {
"description": "Defines the structure and metadata for a variable.",
"id": "AppVariableDeclaration",
"properties": {
"description": {
"description": "Required. The description of the variable.",
"type": "string"
},
"name": {
"description": "Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores.",
"type": "string"
},
"schema": {
"$ref": "Schema",
"description": "Required. The schema of the variable."
}
},
"type": "object"
},
"AppVersion": {
"description": "In Customer Engagement Suite (CES), an app version is a snapshot of the app at a specific point in time. It is immutable and cannot be modified once created.",
"id": "AppVersion",
"properties": {
"createTime": {
"description": "Output only. Timestamp when the app version was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"creator": {
"description": "Output only. Email of the user who created the app version.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. The description of the app version.",
"type": "string"
},
"displayName": {
"description": "Optional. The display name of the app version.",
"type": "string"
},
"etag": {
"description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`",
"type": "string"
},
"snapshot": {
"$ref": "AppSnapshot",
"description": "Output only. The snapshot of the app when the version is created.",
"readOnly": true
}
},
"type": "object"
},
"AudioProcessingConfig": {
"description": "Configuration for how the input and output audio should be processed and delivered.",
"id": "AudioProcessingConfig",
"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."
},
"bargeInConfig": {
"$ref": "BargeInConfig",
"description": "Optional. Configures the agent behavior for the user barge-in activities."
},
"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"
},
"synthesizeSpeechConfigs": {
"additionalProperties": {
"$ref": "SynthesizeSpeechConfig"
},
"description": "Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains \"en-us\" and \"en\", and the specified language code is \"en-gb\", then \"en\" configuration will be used. Note: Language code is case-insensitive.",
"type": "object"
}
},
"type": "object"
},
"AudioRecordingConfig": {
"description": "Configuration for how the audio interactions should be recorded.",
"id": "AudioRecordingConfig",
"properties": {
"gcsBucket": {
"description": "Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with \"gs://\". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.",
"type": "string"
},
"gcsPathPrefix": {
"description": "Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.",
"type": "string"
}
},
"type": "object"
},
"BargeInConfig": {
"description": "Configuration for how the user barge-in activities should be handled.",
"id": "BargeInConfig",
"properties": {
"bargeInAwareness": {
"description": "Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.",
"type": "boolean"
},
"disableBargeIn": {
"deprecated": true,
"description": "Optional. 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.",
"type": "boolean"
}
},
"type": "object"
},
"BatchDeleteConversationsRequest": {
"description": "Request message for AgentService.BatchDeleteConversations.",
"id": "BatchDeleteConversationsRequest",
"properties": {
"conversations": {
"description": "Required. The resource names of the conversations to delete.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BatchDeleteConversationsResponse": {
"description": "Response message for AgentService.BatchDeleteConversations.",
"id": "BatchDeleteConversationsResponse",
"properties": {
"deletedConversations": {
"description": "The list of conversations that were successfully deleted.",
"items": {
"type": "string"
},
"type": "array"
},
"errorMessages": {
"description": "Optional. A list of error messages associated with conversations that failed to be deleted.",
"items": {
"type": "string"
},
"type": "array"
},
"failedConversations": {
"description": "The list of conversations that failed to be deleted.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BearerTokenConfig": {
"description": "Configurations for authentication with a bearer token.",
"id": "BearerTokenConfig",
"properties": {
"token": {
"description": "Required. The bearer token. Must be in the format `$context.variables.`.",
"type": "string"
}
},
"type": "object"
},
"BigQueryExportSettings": {
"description": "Settings to describe the BigQuery export behaviors for the app.",
"id": "BigQueryExportSettings",
"properties": {
"dataset": {
"description": "Optional. The BigQuery **dataset ID** to export the data to.",
"type": "string"
},
"enabled": {
"description": "Optional. Indicates whether the BigQuery export is enabled.",
"type": "boolean"
},
"project": {
"description": "Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.",
"type": "string"
}
},
"type": "object"
},
"Blob": {
"description": "Represents a blob input or output in the conversation.",
"id": "Blob",
"properties": {
"data": {
"description": "Required. Raw bytes of the blob.",
"format": "byte",
"type": "string"
},
"mimeType": {
"description": "Required. The IANA standard MIME type of the source data.",
"type": "string"
}
},
"type": "object"
},
"Callback": {
"description": "A callback defines the custom logic to be executed at various stages of agent interaction.",
"id": "Callback",
"properties": {
"description": {
"description": "Optional. Human-readable description of the callback.",
"type": "string"
},
"disabled": {
"description": "Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.",
"type": "boolean"
},
"proactiveExecutionEnabled": {
"description": "Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.",
"type": "boolean"
},
"pythonCode": {
"description": "Required. The python code to execute for the callback.",
"type": "string"
}
},
"type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest",
"properties": {},
"type": "object"
},
"Changelog": {
"description": "Changelogs represent a change made to the app or to an resource within the app.",
"id": "Changelog",
"properties": {
"action": {
"description": "Output only. The action that was performed on the resource.",
"readOnly": true,
"type": "string"
},
"author": {
"description": "Output only. Email address of the change author.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time when the change was made.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dependentResources": {
"description": "Output only. The dependent resources that were changed.",
"items": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"description": {
"description": "Output only. Description of the change. which typically captures the changed fields in the resource.",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Output only. Display name of the change. It typically should be the display name of the resource that was changed.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The unique identifier of the changelog. Format: `projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}`",
"type": "string"
},
"newResource": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Output only. The new resource after the change.",
"readOnly": true,
"type": "object"
},
"originalResource": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Output only. The original resource before the change.",
"readOnly": true,
"type": "object"
},
"resource": {
"description": "Output only. The resource that was changed.",
"readOnly": true,
"type": "string"
},
"resourceType": {
"description": "Output only. The type of the resource that was changed.",
"readOnly": true,
"type": "string"
},
"sequenceNumber": {
"description": "Output only. The monotonically increasing sequence number of the changelog.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ChannelProfile": {
"description": "A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony.",
"id": "ChannelProfile",
"properties": {
"channelType": {
"description": "Optional. The type of the channel profile.",
"enum": [
"UNKNOWN",
"WEB_UI",
"API",
"TWILIO",
"GOOGLE_TELEPHONY_PLATFORM",
"CONTACT_CENTER_AS_A_SERVICE",
"FIVE9",
"CONTACT_CENTER_INTEGRATION"
],
"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."
],
"type": "string"
},
"disableBargeInControl": {
"description": "Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.",
"type": "boolean"
},
"disableDtmf": {
"description": "Optional. Whether to disable DTMF (dual-tone multi-frequency).",
"type": "boolean"
},
"noiseSuppressionLevel": {
"description": "Optional. The noise suppression level of the channel profile. Available values are \"low\", \"moderate\", \"high\", \"very_high\".",
"type": "string"
},
"personaProperty": {
"$ref": "ChannelProfilePersonaProperty",
"description": "Optional. The persona property of the channel profile."
},
"profileId": {
"description": "Optional. The unique identifier of the channel profile.",
"type": "string"
},
"webWidgetConfig": {
"$ref": "ChannelProfileWebWidgetConfig",
"description": "Optional. The configuration for the web widget."
}
},
"type": "object"
},
"ChannelProfilePersonaProperty": {
"description": "Represents the persona property of a channel.",
"id": "ChannelProfilePersonaProperty",
"properties": {
"persona": {
"description": "Optional. The persona of the channel.",
"enum": [
"UNKNOWN",
"CONCISE",
"CHATTY"
],
"enumDescriptions": [
"UNKNOWN persona.",
"The agent keeps the responses concise and to the point",
"The agent provides additional context, explanations, and details"
],
"type": "string"
}
},
"type": "object"
},
"ChannelProfileWebWidgetConfig": {
"description": "Message for configuration for the web widget.",
"id": "ChannelProfileWebWidgetConfig",
"properties": {
"modality": {
"description": "Optional. The modality of the web widget.",
"enum": [
"MODALITY_UNSPECIFIED",
"CHAT_AND_VOICE",
"VOICE_ONLY",
"CHAT_ONLY",
"CHAT_VOICE_AND_VIDEO"
],
"enumDescriptions": [
"Unknown modality.",
"Widget supports both chat and voice input.",
"Widget supports only voice input.",
"Widget supports only chat input.",
"Widget supports chat, voice, and video input."
],
"type": "string"
},
"securitySettings": {
"$ref": "ChannelProfileWebWidgetConfigSecuritySettings",
"description": "Optional. The security settings of the web widget."
},
"theme": {
"description": "Optional. The theme of the web widget.",
"enum": [
"THEME_UNSPECIFIED",
"LIGHT",
"DARK"
],
"enumDescriptions": [
"Unknown theme.",
"Light theme.",
"Dark theme."
],
"type": "string"
},
"webWidgetTitle": {
"description": "Optional. The title of the web widget.",
"type": "string"
}
},
"type": "object"
},
"ChannelProfileWebWidgetConfigSecuritySettings": {
"description": "Security settings for the web widget.",
"id": "ChannelProfileWebWidgetConfigSecuritySettings",
"properties": {
"allowedOrigins": {
"description": "Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: \"https://example.com\"",
"items": {
"type": "string"
},
"type": "array"
},
"enableOriginCheck": {
"description": "Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.",
"type": "boolean"
},
"enablePublicAccess": {
"description": "Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.",
"type": "boolean"
},
"enableRecaptcha": {
"description": "Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Chunk": {
"description": "A chunk of content within a message.",
"id": "Chunk",
"properties": {
"agentTransfer": {
"$ref": "AgentTransfer",
"description": "Optional. Agent transfer event."
},
"blob": {
"$ref": "Blob",
"description": "Optional. Blob data."
},
"defaultVariables": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "A struct represents default variables at the start of the conversation, keyed by variable names.",
"type": "object"
},
"image": {
"$ref": "Image",
"description": "Optional. Image data."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. Custom payload data.",
"type": "object"
},
"text": {
"description": "Optional. Text data.",
"type": "string"
},
"toolCall": {
"$ref": "ToolCall",
"description": "Optional. Tool execution request."
},
"toolResponse": {
"$ref": "ToolResponse",
"description": "Optional. Tool execution response."
},
"transcript": {
"description": "Optional. Transcript associated with the audio.",
"type": "string"
},
"updatedVariables": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "A struct represents variables that were updated in the conversation, keyed by variable names.",
"type": "object"
}
},
"type": "object"
},
"Citations": {
"description": "Citations associated with the agent response.",
"id": "Citations",
"properties": {
"citedChunks": {
"description": "List of cited pieces of information.",
"items": {
"$ref": "CitationsCitedChunk"
},
"type": "array"
}
},
"type": "object"
},
"CitationsCitedChunk": {
"description": "Piece of cited information.",
"id": "CitationsCitedChunk",
"properties": {
"text": {
"description": "Text used for citation.",
"type": "string"
},
"title": {
"description": "Title of the cited document.",
"type": "string"
},
"uri": {
"description": "URI used for citation.",
"type": "string"
}
},
"type": "object"
},
"ClientCertificateSettings": {
"description": "Settings for custom client certificates.",
"id": "ClientCertificateSettings",
"properties": {
"passphrase": {
"description": "Optional. The name of the SecretManager secret version resource storing the passphrase to decrypt the private key. Should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`",
"type": "string"
},
"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"
}
},
"type": "object"
},
"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",
"properties": {
"description": {
"description": "Optional. The function description.",
"type": "string"
},
"name": {
"description": "Required. The function name.",
"type": "string"
},
"parameters": {
"$ref": "Schema",
"description": "Optional. The schema of the function parameters."
},
"response": {
"$ref": "Schema",
"description": "Optional. The schema of the function response."
}
},
"type": "object"
},
"CloudLoggingSettings": {
"description": "Settings to describe the Cloud Logging behaviors for the app.",
"id": "CloudLoggingSettings",
"properties": {
"enableCloudLogging": {
"description": "Optional. Whether to enable Cloud Logging for the sessions.",
"type": "boolean"
}
},
"type": "object"
},
"CodeBlock": {
"description": "A code block to be executed instead of a real tool call.",
"id": "CodeBlock",
"properties": {
"pythonCode": {
"description": "Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.",
"type": "string"
}
},
"type": "object"
},
"ConnectorTool": {
"description": "A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview.",
"id": "ConnectorTool",
"properties": {
"action": {
"$ref": "Action",
"description": "Required. Action for the tool to use."
},
"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."
},
"connection": {
"description": "Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`",
"type": "string"
},
"description": {
"description": "Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.",
"type": "string"
},
"name": {
"description": "Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.",
"type": "string"
}
},
"type": "object"
},
"ConnectorToolset": {
"description": "A toolset that generates tools from an Integration Connectors Connection.",
"id": "ConnectorToolset",
"properties": {
"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 Toolset creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override"
},
"connection": {
"description": "Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`",
"type": "string"
},
"connectorActions": {
"description": "Required. The list of connector actions/entity operations to generate tools for.",
"items": {
"$ref": "Action"
},
"type": "array"
}
},
"type": "object"
},
"Conversation": {
"description": "A conversation represents an interaction between an end user and the CES app.",
"id": "Conversation",
"properties": {
"appVersion": {
"description": "Output only. The version of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`",
"readOnly": true,
"type": "string"
},
"channelType": {
"deprecated": true,
"description": "DEPRECATED. Please use input_types instead.",
"enum": [
"CHANNEL_TYPE_UNSPECIFIED",
"TEXT",
"AUDIO",
"MULTIMODAL"
],
"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"
},
"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"
},
"endTime": {
"description": "Output only. Timestamp when the conversation was completed.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"entryAgent": {
"description": "Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
"readOnly": true,
"type": "string"
},
"inputTypes": {
"description": "Output only. The input types of the conversation.",
"items": {
"enum": [
"INPUT_TYPE_UNSPECIFIED",
"INPUT_TYPE_TEXT",
"INPUT_TYPE_EVENT",
"INPUT_TYPE_AUDIO",
"INPUT_TYPE_IMAGE",
"INPUT_TYPE_BLOB",
"INPUT_TYPE_TOOL_RESPONSE",
"INPUT_TYPE_VARIABLES"
],
"enumDescriptions": [
"Unspecified input type.",
"Text input.",
"Event input.",
"Audio input.",
"Image input.",
"Blob input.",
"Client function tool response input.",
"Variables input."
],
"type": "string"
},
"readOnly": true,
"type": "array"
},
"languageCode": {
"description": "Output only. The language code of the conversation.",
"readOnly": true,
"type": "string"
},
"messages": {
"deprecated": true,
"description": "Deprecated. Use turns instead.",
"items": {
"$ref": "Message"
},
"type": "array"
},
"name": {
"description": "Identifier. The unique identifier of the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`",
"type": "string"
},
"source": {
"description": "Output only. Indicate the source of the conversation.",
"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."
],
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Output only. Timestamp when the conversation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"turnCount": {
"description": "Output only. The number of turns in the conversation.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"turns": {
"description": "Required. The turns in the conversation.",
"items": {
"$ref": "ConversationTurn"
},
"type": "array"
}
},
"type": "object"
},
"ConversationLoggingSettings": {
"description": "Settings to describe the conversation logging behaviors for the app.",
"id": "ConversationLoggingSettings",
"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.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"ConversationTurn": {
"description": "All information about a single turn in the conversation.",
"id": "ConversationTurn",
"properties": {
"messages": {
"description": "Optional. List of messages in the conversation turn, including user input, agent responses and intermediate events during the processing.",
"items": {
"$ref": "Message"
},
"type": "array"
},
"rootSpan": {
"$ref": "Span",
"description": "Optional. The root span of the action processing."
}
},
"type": "object"
},
"DataStore": {
"description": "A DataStore resource in Vertex AI Search.",
"id": "DataStore",
"properties": {
"connectorConfig": {
"$ref": "DataStoreConnectorConfig",
"description": "Output only. The connector config for the data store connection.",
"readOnly": true
},
"createTime": {
"description": "Output only. Timestamp when the data store was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Output only. The display name of the data store.",
"readOnly": true,
"type": "string"
},
"documentProcessingMode": {
"description": "Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.",
"enum": [
"DOCUMENT_PROCESSING_MODE_UNSPECIFIED",
"DOCUMENTS",
"CHUNKS"
],
"enumDescriptions": [
"Not specified.",
"Documents are processed as documents.",
"Documents are converted to chunks."
],
"readOnly": true,
"type": "string"
},
"name": {
"description": "Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`",
"type": "string"
},
"type": {
"description": "Output only. The type of the data store. This field is readonly and populated by the server.",
"enum": [
"DATA_STORE_TYPE_UNSPECIFIED",
"PUBLIC_WEB",
"UNSTRUCTURED",
"FAQ",
"CONNECTOR"
],
"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."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"DataStoreConnectorConfig": {
"description": "The connector config for the data store connection.",
"id": "DataStoreConnectorConfig",
"properties": {
"collection": {
"description": "Resource name of the collection the data store belongs to.",
"type": "string"
},
"collectionDisplayName": {
"description": "Display name of the collection the data store belongs to.",
"type": "string"
},
"dataSource": {
"description": "The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.",
"type": "string"
}
},
"type": "object"
},
"DataStoreSettings": {
"description": "Data store related settings for the app.",
"id": "DataStoreSettings",
"properties": {
"engines": {
"description": "Output only. The engines for the app.",
"items": {
"$ref": "DataStoreSettingsEngine"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"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",
"properties": {
"name": {
"description": "Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Output only. The type of the engine.",
"enum": [
"TYPE_UNSPECIFIED",
"ENGINE_TYPE_SEARCH",
"ENGINE_TYPE_CHAT"
],
"enumDescriptions": [
"Unspecified engine type.",
"The SOLUTION_TYPE_SEARCH engine for the app. All connector data stores added to the app will be added to this engine.",
"Chat engine type. The SOLUTION_TYPE_CHAT engine for the app. All connector data stores added to the app will be added to this engine."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"DataStoreTool": {
"description": "Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.",
"id": "DataStoreTool",
"properties": {
"boostSpecs": {
"description": "Optional. Boost specification to boost certain documents.",
"items": {
"$ref": "DataStoreToolBoostSpecs"
},
"type": "array"
},
"dataStoreSource": {
"$ref": "DataStoreToolDataStoreSource",
"description": "Optional. Search within a single specific DataStore."
},
"description": {
"description": "Optional. The tool description.",
"type": "string"
},
"engineSource": {
"$ref": "DataStoreToolEngineSource",
"description": "Optional. Search within an Engine (potentially across multiple DataStores)."
},
"filterParameterBehavior": {
"description": "Optional. The filter parameter behavior.",
"enum": [
"FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED",
"ALWAYS_INCLUDE",
"NEVER_INCLUDE"
],
"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."
],
"type": "string"
},
"modalityConfigs": {
"description": "Optional. The modality configs for the data store.",
"items": {
"$ref": "DataStoreToolModalityConfig"
},
"type": "array"
},
"name": {
"description": "Required. The data store tool name.",
"type": "string"
}
},
"type": "object"
},
"DataStoreToolBoostSpec": {
"description": "Boost specification to boost certain documents.",
"id": "DataStoreToolBoostSpec",
"properties": {
"conditionBoostSpecs": {
"description": "Required. A list of boosting specifications.",
"items": {
"$ref": "DataStoreToolBoostSpecConditionBoostSpec"
},
"type": "array"
}
},
"type": "object"
},
"DataStoreToolBoostSpecConditionBoostSpec": {
"description": "Boost specification for a condition.",
"id": "DataStoreToolBoostSpecConditionBoostSpec",
"properties": {
"boost": {
"description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.",
"format": "float",
"type": "number"
},
"boostControlSpec": {
"$ref": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec",
"description": "Optional. Complex specification for custom ranking based on customer defined attribute value."
},
"condition": {
"description": "Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY(\"en\", \"fr\"))",
"type": "string"
}
},
"type": "object"
},
"DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec": {
"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.",
"id": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec",
"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).",
"enum": [
"ATTRIBUTE_TYPE_UNSPECIFIED",
"NUMERICAL",
"FRESHNESS"
],
"enumDescriptions": [
"Unspecified AttributeType.",
"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. E.g. `5D`, `3DT12H30M`, `T24H`."
],
"type": "string"
},
"controlPoints": {
"description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.",
"items": {
"$ref": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint"
},
"type": "array"
},
"fieldName": {
"description": "Optional. The name of the field whose value will be used to determine the boost amount.",
"type": "string"
},
"interpolationType": {
"description": "Optional. The interpolation type to be applied to connect the control points listed below.",
"enum": [
"INTERPOLATION_TYPE_UNSPECIFIED",
"LINEAR"
],
"enumDescriptions": [
"Interpolation type is unspecified. In this case, it defaults to Linear.",
"Piecewise linear interpolation will be applied."
],
"type": "string"
}
},
"type": "object"
},
"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",
"properties": {
"attributeValue": {
"description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.",
"type": "string"
},
"boostAmount": {
"description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"DataStoreToolBoostSpecs": {
"description": "Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.",
"id": "DataStoreToolBoostSpecs",
"properties": {
"dataStores": {
"description": "Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.",
"items": {
"type": "string"
},
"type": "array"
},
"spec": {
"description": "Required. A list of boosting specifications.",
"items": {
"$ref": "DataStoreToolBoostSpec"
},
"type": "array"
}
},
"type": "object"
},
"DataStoreToolDataStoreSource": {
"description": "Configuration for searching within a specific DataStore.",
"id": "DataStoreToolDataStoreSource",
"properties": {
"dataStore": {
"$ref": "DataStore",
"description": "Optional. The data store."
},
"filter": {
"description": "Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata",
"type": "string"
}
},
"type": "object"
},
"DataStoreToolEngineSource": {
"description": "Configuration for searching within an Engine, potentially targeting specific DataStores.",
"id": "DataStoreToolEngineSource",
"properties": {
"dataStoreSources": {
"description": "Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.",
"items": {
"$ref": "DataStoreToolDataStoreSource"
},
"type": "array"
},
"engine": {
"description": "Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
"type": "string"
},
"filter": {
"description": "Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata",
"type": "string"
}
},
"type": "object"
},
"DataStoreToolGroundingConfig": {
"description": "Grounding configuration.",
"id": "DataStoreToolGroundingConfig",
"properties": {
"disabled": {
"description": "Optional. Whether grounding is disabled.",
"type": "boolean"
},
"groundingLevel": {
"description": "Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"DataStoreToolModalityConfig": {
"description": "If specified, will apply the given configuration for the specified modality.",
"id": "DataStoreToolModalityConfig",
"properties": {
"groundingConfig": {
"$ref": "DataStoreToolGroundingConfig",
"description": "Optional. The grounding configuration."
},
"modalityType": {
"description": "Required. The modality type.",
"enum": [
"MODALITY_TYPE_UNSPECIFIED",
"TEXT",
"AUDIO"
],
"enumDescriptions": [
"Unspecified modality type.",
"Text modality.",
"Audio modality."
],
"type": "string"
},
"rewriterConfig": {
"$ref": "DataStoreToolRewriterConfig",
"description": "Optional. The rewriter config."
},
"summarizationConfig": {
"$ref": "DataStoreToolSummarizationConfig",
"description": "Optional. The summarization config."
}
},
"type": "object"
},
"DataStoreToolRewriterConfig": {
"description": "Rewriter configuration.",
"id": "DataStoreToolRewriterConfig",
"properties": {
"disabled": {
"description": "Optional. Whether the rewriter is disabled.",
"type": "boolean"
},
"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"
}
},
"type": "object"
},
"DataStoreToolSummarizationConfig": {
"description": "Summarization configuration.",
"id": "DataStoreToolSummarizationConfig",
"properties": {
"disabled": {
"description": "Optional. Whether summarization is disabled.",
"type": "boolean"
},
"modelSettings": {
"$ref": "ModelSettings",
"description": "Optional. Configurations for the LLM model."
},
"prompt": {
"description": "Optional. The prompt definition. If not set, default prompt will be used.",
"type": "string"
}
},
"type": "object"
},
"DeleteEvaluationRunOperationMetadata": {
"description": "Operation metadata for EvaluationService.DeleteEvaluationRun.",
"id": "DeleteEvaluationRunOperationMetadata",
"properties": {},
"type": "object"
},
"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",
"properties": {
"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"
},
"channelProfile": {
"$ref": "ChannelProfile",
"description": "Required. The channel profile used in the deployment."
},
"createTime": {
"description": "Output only. Timestamp when this deployment was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. Display name of the deployment.",
"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"
},
"experimentConfig": {
"$ref": "ExperimentConfig",
"description": "Optional. Experiment configuration for the deployment."
},
"name": {
"description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`",
"type": "string"
},
"updateTime": {
"description": "Output only. Timestamp when this deployment was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"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",
"properties": {
"metadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. Provides additional information about the end session signal, such as the reason for ending the session.",
"type": "object"
}
},
"type": "object"
},
"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",
"properties": {
"oauth2AuthCodeConfig": {
"$ref": "EndUserAuthConfigOauth2AuthCodeConfig",
"description": "Oauth 2.0 Authorization Code authentication."
},
"oauth2JwtBearerConfig": {
"$ref": "EndUserAuthConfigOauth2JwtBearerConfig",
"description": "JWT Profile Oauth 2.0 Authorization Grant authentication."
}
},
"type": "object"
},
"EndUserAuthConfigOauth2AuthCodeConfig": {
"description": "Oauth 2.0 Authorization Code authentication configuration.",
"id": "EndUserAuthConfigOauth2AuthCodeConfig",
"properties": {
"oauthToken": {
"description": "Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.",
"type": "string"
}
},
"type": "object"
},
"EndUserAuthConfigOauth2JwtBearerConfig": {
"description": "JWT Profile Oauth 2.0 Authorization Grant authentication configuration.",
"id": "EndUserAuthConfigOauth2JwtBearerConfig",
"properties": {
"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"
},
"subject": {
"description": "Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.",
"type": "string"
}
},
"type": "object"
},
"EndpointControlPolicy": {
"description": "Defines project/location level endpoint control policy.",
"id": "EndpointControlPolicy",
"properties": {
"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\".",
"items": {
"type": "string"
},
"type": "array"
},
"enforcementScope": {
"description": "Optional. The scope in which this policy's allowed_origins list is enforced.",
"enum": [
"ENFORCEMENT_SCOPE_UNSPECIFIED",
"VPCSC_ONLY",
"ALWAYS"
],
"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."
],
"type": "string"
}
},
"type": "object"
},
"ErrorHandlingSettings": {
"description": "Settings to describe how errors should be handled in the app.",
"id": "ErrorHandlingSettings",
"properties": {
"endSessionConfig": {
"$ref": "ErrorHandlingSettingsEndSessionConfig",
"description": "Optional. Configuration for ending the session in case of system errors (e.g. LLM errors)."
},
"errorHandlingStrategy": {
"description": "Optional. The strategy to use for error handling.",
"enum": [
"ERROR_HANDLING_STRATEGY_UNSPECIFIED",
"NONE",
"FALLBACK_RESPONSE",
"END_SESSION"
],
"enumDescriptions": [
"Unspecified error handling strategy.",
"No specific handling is enabled.",
"A fallback message will be returned to the user in case of system errors (e.g. LLM errors).",
"An EndSession signal will be emitted in case of system errors (e.g. LLM errors)."
],
"type": "string"
},
"fallbackResponseConfig": {
"$ref": "ErrorHandlingSettingsFallbackResponseConfig",
"description": "Optional. Configuration for handling fallback responses."
}
},
"type": "object"
},
"ErrorHandlingSettingsEndSessionConfig": {
"description": "Configuration for ending the session in case of system errors (e.g. LLM errors).",
"id": "ErrorHandlingSettingsEndSessionConfig",
"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"
}
},
"type": "object"
},
"ErrorHandlingSettingsFallbackResponseConfig": {
"description": "Configuration for handling fallback responses.",
"id": "ErrorHandlingSettingsFallbackResponseConfig",
"properties": {
"customFallbackMessages": {
"additionalProperties": {
"type": "string"
},
"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"
},
"maxFallbackAttempts": {
"description": "Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Evaluation": {
"description": "An evaluation represents all of the information needed to simulate and evaluate an agent.",
"id": "Evaluation",
"properties": {
"aggregatedMetrics": {
"$ref": "AggregatedMetrics",
"description": "Output only. The aggregated metrics for this evaluation across all runs.",
"readOnly": true
},
"createTime": {
"description": "Output only. Timestamp when the evaluation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"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"
},
"displayName": {
"description": "Required. User-defined display name of the evaluation. Unique within an App.",
"type": "string"
},
"etag": {
"description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.",
"readOnly": true,
"type": "string"
},
"evaluationDatasets": {
"description": "Output only. List of evaluation datasets the evaluation belongs to. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"evaluationRuns": {
"description": "Output only. The EvaluationRuns that this Evaluation is associated with.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"golden": {
"$ref": "EvaluationGolden",
"description": "Optional. The golden steps to be evaluated."
},
"invalid": {
"description": "Output only. Whether the evaluation is invalid. This can happen if an evaluation is referencing a tool, toolset, or agent that has since been deleted.",
"readOnly": true,
"type": "boolean"
},
"lastCompletedResult": {
"$ref": "EvaluationResult",
"description": "Output only. The latest evaluation result for this evaluation.",
"readOnly": true
},
"lastTenResults": {
"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.",
"items": {
"$ref": "EvaluationResult"
},
"readOnly": true,
"type": "array"
},
"lastUpdatedBy": {
"description": "Output only. The user who last updated the evaluation.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The unique identifier of this evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`",
"type": "string"
},
"scenario": {
"$ref": "EvaluationScenario",
"description": "Optional. The config for a scenario."
},
"tags": {
"description": "Optional. User defined tags to categorize the evaluation.",
"items": {
"type": "string"
},
"type": "array"
},
"updateTime": {
"description": "Output only. Timestamp when the evaluation was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EvaluationConfig": {
"description": "EvaluationConfig configures settings for running the evaluation.",
"id": "EvaluationConfig",
"properties": {
"evaluationChannel": {
"description": "Optional. The channel to evaluate.",
"enum": [
"EVALUATION_CHANNEL_UNSPECIFIED",
"TEXT",
"AUDIO"
],
"enumDescriptions": [
"Unspecified evaluation channel.",
"Text-only evaluation channel.",
"Audio evaluation channel."
],
"type": "string"
},
"inputAudioConfig": {
"$ref": "InputAudioConfig",
"deprecated": true,
"description": "Optional. Configuration for processing the input audio."
},
"outputAudioConfig": {
"$ref": "OutputAudioConfig",
"deprecated": true,
"description": "Optional. Configuration for generating the output audio."
},
"toolCallBehaviour": {
"description": "Optional. Specifies whether the evaluation should use real tool calls or fake tools.",
"enum": [
"EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED",
"REAL",
"FAKE"
],
"enumDescriptions": [
"Unspecified tool call behavior. Will default to real tool calls.",
"Use real tool calls.",
"Use fake tool calls."
],
"type": "string"
}
},
"type": "object"
},
"EvaluationDataset": {
"description": "An evaluation dataset represents a set of evaluations that are grouped together basaed on shared tags.",
"id": "EvaluationDataset",
"properties": {
"aggregatedMetrics": {
"$ref": "AggregatedMetrics",
"description": "Output only. The aggregated metrics for this evaluation dataset across all runs.",
"readOnly": true
},
"createTime": {
"description": "Output only. Timestamp when the evaluation dataset was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"createdBy": {
"description": "Output only. The user who created the evaluation dataset.",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. User-defined display name of the evaluation dataset. Unique within an App.",
"type": "string"
},
"etag": {
"description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.",
"readOnly": true,
"type": "string"
},
"evaluations": {
"description": "Optional. Evaluations that are included in this dataset.",
"items": {
"type": "string"
},
"type": "array"
},
"lastUpdatedBy": {
"description": "Output only. The user who last updated the evaluation dataset.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The unique identifier of this evaluation dataset. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`",
"type": "string"
},
"updateTime": {
"description": "Output only. Timestamp when the evaluation dataset was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EvaluationErrorInfo": {
"description": "Information about an error encountered during an evaluation execution.",
"id": "EvaluationErrorInfo",
"properties": {
"errorMessage": {
"description": "Output only. The error message.",
"readOnly": true,
"type": "string"
},
"errorType": {
"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"
],
"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."
],
"readOnly": true,
"type": "string"
},
"sessionId": {
"description": "Output only. The session ID for the conversation that caused the error.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EvaluationExpectation": {
"description": "An evaluation expectation represents a specific criteria to evaluate against.",
"id": "EvaluationExpectation",
"properties": {
"createTime": {
"description": "Output only. Timestamp when the evaluation expectation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. User-defined display name. Must be unique within the app.",
"type": "string"
},
"etag": {
"description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.",
"readOnly": true,
"type": "string"
},
"llmCriteria": {
"$ref": "EvaluationExpectationLlmCriteria",
"description": "Optional. Evaluation criteria based on an LLM prompt."
},
"name": {
"description": "Identifier. The unique identifier of this evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`",
"type": "string"
},
"tags": {
"description": "Optional. User-defined tags for expectations. Can be used to filter expectations.",
"items": {
"type": "string"
},
"type": "array"
},
"updateTime": {
"description": "Output only. Timestamp when the evaluation expectation was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EvaluationExpectationLlmCriteria": {
"description": "Configuration for LLM-based evaluation criteria.",
"id": "EvaluationExpectationLlmCriteria",
"properties": {
"prompt": {
"description": "Required. The prompt/instructions provided to the LLM judge.",
"type": "string"
}
},
"type": "object"
},
"EvaluationGolden": {
"description": "The steps required to replay a golden conversation.",
"id": "EvaluationGolden",
"properties": {
"evaluationExpectations": {
"description": "Optional. The evaluation expectations to evaluate the replayed conversation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}`",
"items": {
"type": "string"
},
"type": "array"
},
"turns": {
"description": "Required. The golden turns required to replay a golden conversation.",
"items": {
"$ref": "EvaluationGoldenTurn"
},
"type": "array"
}
},
"type": "object"
},
"EvaluationGoldenExpectation": {
"description": "Represents a single, checkable requirement.",
"id": "EvaluationGoldenExpectation",
"properties": {
"agentResponse": {
"$ref": "Message",
"description": "Optional. Check that the agent responded with the correct response. The role \"agent\" is implied."
},
"agentTransfer": {
"$ref": "AgentTransfer",
"description": "Optional. Check that the agent transferred the conversation to a different agent."
},
"mockToolResponse": {
"$ref": "ToolResponse",
"description": "Optional. The tool response to mock, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM."
},
"note": {
"description": "Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., \"Check_Payment_Tool_Called\".",
"type": "string"
},
"toolCall": {
"$ref": "ToolCall",
"description": "Optional. Check that a specific tool was called with the parameters."
},
"toolResponse": {
"$ref": "ToolResponse",
"description": "Optional. Check that a specific tool had the expected response."
},
"updatedVariables": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"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"
}
},
"type": "object"
},
"EvaluationGoldenTurn": {
"description": "A golden turn defines a single turn in a golden conversation.",
"id": "EvaluationGoldenTurn",
"properties": {
"rootSpan": {
"$ref": "Span",
"description": "Optional. The root span of the golden turn for processing and maintaining audio information."
},
"steps": {
"description": "Required. The steps required to replay a golden conversation.",
"items": {
"$ref": "EvaluationStep"
},
"type": "array"
}
},
"type": "object"
},
"EvaluationMetricsThresholds": {
"description": "Threshold settings for metrics in an Evaluation.",
"id": "EvaluationMetricsThresholds",
"properties": {
"goldenEvaluationMetricsThresholds": {
"$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds",
"description": "Optional. The golden evaluation metrics thresholds."
},
"goldenHallucinationMetricBehavior": {
"description": "Optional. The hallucination metric behavior for golden evaluations.",
"enum": [
"HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED",
"DISABLED",
"ENABLED"
],
"enumDescriptions": [
"Unspecified hallucination metric behavior.",
"Disable hallucination metric.",
"Enable hallucination metric."
],
"type": "string"
},
"hallucinationMetricBehavior": {
"deprecated": true,
"description": "Optional. Deprecated: Use `golden_hallucination_metric_behavior` instead. The hallucination metric behavior is currently used for golden evaluations.",
"enum": [
"HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED",
"DISABLED",
"ENABLED"
],
"enumDescriptions": [
"Unspecified hallucination metric behavior.",
"Disable hallucination metric.",
"Enable hallucination metric."
],
"type": "string"
},
"scenarioHallucinationMetricBehavior": {
"description": "Optional. The hallucination metric behavior for scenario evaluations.",
"enum": [
"HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED",
"DISABLED",
"ENABLED"
],
"enumDescriptions": [
"Unspecified hallucination metric behavior.",
"Disable hallucination metric.",
"Enable hallucination metric."
],
"type": "string"
}
},
"type": "object"
},
"EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds": {
"description": "Settings for golden evaluations.",
"id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds",
"properties": {
"expectationLevelMetricsThresholds": {
"$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds",
"description": "Optional. The expectation level metrics thresholds."
},
"toolMatchingSettings": {
"$ref": "EvaluationMetricsThresholdsToolMatchingSettings",
"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."
},
"turnLevelMetricsThresholds": {
"$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds",
"description": "Optional. The turn level metrics thresholds."
}
},
"type": "object"
},
"EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds": {
"description": "Expectation level metrics thresholds.",
"id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds",
"properties": {
"toolInvocationParameterCorrectnessThreshold": {
"description": "Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds": {
"description": "Turn level metrics thresholds.",
"id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds",
"properties": {
"overallToolInvocationCorrectnessThreshold": {
"description": "Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.",
"format": "float",
"type": "number"
},
"semanticSimilarityChannel": {
"description": "Optional. The semantic similarity channel to use for evaluation.",
"enum": [
"SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED",
"TEXT",
"AUDIO"
],
"enumDescriptions": [
"Metric unspecified. Defaults to TEXT.",
"Use text semantic similarity.",
"Use audio semantic similarity."
],
"type": "string"
},
"semanticSimilaritySuccessThreshold": {
"description": "Optional. The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is >= 3.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"EvaluationMetricsThresholdsToolMatchingSettings": {
"description": "Settings for matching tool calls.",
"id": "EvaluationMetricsThresholdsToolMatchingSettings",
"properties": {
"extraToolCallBehavior": {
"description": "Optional. Behavior for extra tool calls. Defaults to FAIL.",
"enum": [
"EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED",
"FAIL",
"ALLOW"
],
"enumDescriptions": [
"Unspecified behavior. Defaults to FAIL.",
"Fail the evaluation if an extra tool call is encountered.",
"Allow the extra tool call."
],
"type": "string"
}
},
"type": "object"
},
"EvaluationPersona": {
"description": "A persona represents an end user in an evaluation.",
"id": "EvaluationPersona",
"properties": {
"description": {
"description": "Optional. The description of the persona.",
"type": "string"
},
"displayName": {
"description": "Required. The display name of the persona. Unique within an app.",
"type": "string"
},
"name": {
"description": "Required. The unique identifier of the persona. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`",
"type": "string"
},
"personality": {
"description": "Required. An instruction for the agent on how to behave in the evaluation.",
"type": "string"
},
"speechConfig": {
"$ref": "EvaluationPersonaSpeechConfig",
"description": "Optional. Configuration for how the persona sounds (TTS settings)."
}
},
"type": "object"
},
"EvaluationPersonaSpeechConfig": {
"description": "Configuration for Text-to-Speech generation.",
"id": "EvaluationPersonaSpeechConfig",
"properties": {
"environment": {
"description": "Optional. The simulated audio environment.",
"enum": [
"BACKGROUND_ENVIRONMENT_UNSPECIFIED",
"CALL_CENTER",
"TRAFFIC",
"KIDS_NOISE",
"CAFE"
],
"enumDescriptions": [
"Background environment unspecified.",
"Call center environment.",
"Traffic noise environment.",
"Kids noise environment.",
"Cafe environment."
],
"type": "string"
},
"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.",
"format": "double",
"type": "number"
},
"voiceId": {
"description": "Optional. The specific voice identifier/accent to use. Example: \"en-US-Wavenet-D\" or \"en-GB-Standard-A\"",
"type": "string"
}
},
"type": "object"
},
"EvaluationResult": {
"description": "An evaluation result represents the output of running an Evaluation.",
"id": "EvaluationResult",
"properties": {
"appVersion": {
"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,
"type": "string"
},
"appVersionDisplayName": {
"description": "Output only. The display name of the `app_version` that the evaluation ran against.",
"readOnly": true,
"type": "string"
},
"changelog": {
"description": "Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.",
"readOnly": true,
"type": "string"
},
"changelogCreateTime": {
"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.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"config": {
"$ref": "EvaluationConfig",
"description": "Output only. The configuration used in the evaluation run that resulted in this result.",
"readOnly": true
},
"createTime": {
"description": "Output only. Timestamp when the evaluation result was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. Display name of the Evaluation Result. Unique within an Evaluation. By default, it has the following format: \" result - \".",
"type": "string"
},
"error": {
"$ref": "Status",
"deprecated": true,
"description": "Output only. Deprecated: Use `error_info` instead. Errors encountered during execution.",
"readOnly": true
},
"errorInfo": {
"$ref": "EvaluationErrorInfo",
"description": "Output only. Error information for the evaluation result.",
"readOnly": true
},
"evaluationMetricsThresholds": {
"$ref": "EvaluationMetricsThresholds",
"description": "Output only. The evaluation thresholds for the result.",
"readOnly": true
},
"evaluationRun": {
"description": "Output only. The evaluation run that produced this result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`",
"readOnly": true,
"type": "string"
},
"evaluationStatus": {
"description": "Output only. The outcome of the evaluation. Only populated if execution_state is COMPLETE.",
"enum": [
"OUTCOME_UNSPECIFIED",
"PASS",
"FAIL",
"SKIPPED"
],
"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."
],
"readOnly": true,
"type": "string"
},
"executionState": {
"description": "Output only. The state of the evaluation result execution.",
"enum": [
"EXECUTION_STATE_UNSPECIFIED",
"RUNNING",
"COMPLETED",
"ERROR"
],
"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."
],
"readOnly": true,
"type": "string"
},
"goldenResult": {
"$ref": "EvaluationResultGoldenResult",
"description": "Output only. The outcome of a golden evaluation.",
"readOnly": true
},
"goldenRunMethod": {
"description": "Output only. The method used to run the golden evaluation.",
"enum": [
"GOLDEN_RUN_METHOD_UNSPECIFIED",
"STABLE",
"NAIVE"
],
"enumDescriptions": [
"Run method is not specified.",
"Run the evaluation as stable replay, where each turn is a unique session with the previous expected turns injected as context.",
"Run the evaluation as naive replay, where the run is a single session with no context injected."
],
"readOnly": true,
"type": "string"
},
"initiatedBy": {
"description": "Output only. The user who initiated the evaluation run that resulted in this result.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`",
"type": "string"
},
"persona": {
"$ref": "EvaluationPersona",
"description": "Output only. The persona used to generate the conversation for the evaluation result.",
"readOnly": true
},
"scenarioResult": {
"$ref": "EvaluationResultScenarioResult",
"description": "Output only. The outcome of a scenario evaluation.",
"readOnly": true
}
},
"type": "object"
},
"EvaluationResultEvaluationExpectationResult": {
"description": "The result of a single evaluation expectation.",
"id": "EvaluationResultEvaluationExpectationResult",
"properties": {
"evaluationExpectation": {
"description": "Output only. The evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`",
"readOnly": true,
"type": "string"
},
"explanation": {
"description": "Output only. The explanation for the result.",
"readOnly": true,
"type": "string"
},
"outcome": {
"description": "Output only. The outcome of the evaluation expectation.",
"enum": [
"OUTCOME_UNSPECIFIED",
"PASS",
"FAIL",
"SKIPPED"
],
"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."
],
"readOnly": true,
"type": "string"
},
"prompt": {
"description": "Output only. The prompt that was used for the evaluation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EvaluationResultGoldenExpectationOutcome": {
"description": "Specifies the expectation and the result of that expectation.",
"id": "EvaluationResultGoldenExpectationOutcome",
"properties": {
"expectation": {
"$ref": "EvaluationGoldenExpectation",
"description": "Output only. The expectation that was evaluated.",
"readOnly": true
},
"observedAgentResponse": {
"$ref": "Message",
"description": "Output only. The result of the agent response expectation.",
"readOnly": true
},
"observedAgentTransfer": {
"$ref": "AgentTransfer",
"description": "Output only. The result of the agent transfer expectation.",
"readOnly": true
},
"observedToolCall": {
"$ref": "ToolCall",
"description": "Output only. The result of the tool call expectation.",
"readOnly": true
},
"observedToolResponse": {
"$ref": "ToolResponse",
"description": "Output only. The result of the tool response expectation.",
"readOnly": true
},
"outcome": {
"description": "Output only. The outcome of the expectation.",
"enum": [
"OUTCOME_UNSPECIFIED",
"PASS",
"FAIL",
"SKIPPED"
],
"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."
],
"readOnly": true,
"type": "string"
},
"semanticSimilarityResult": {
"$ref": "EvaluationResultSemanticSimilarityResult",
"deprecated": true,
"description": "Output only. The result of the semantic similarity check.",
"readOnly": true
},
"toolInvocationResult": {
"$ref": "EvaluationResultGoldenExpectationOutcomeToolInvocationResult",
"description": "Output only. The result of the tool invocation check.",
"readOnly": true
}
},
"type": "object"
},
"EvaluationResultGoldenExpectationOutcomeToolInvocationResult": {
"description": "The result of the tool invocation check.",
"id": "EvaluationResultGoldenExpectationOutcomeToolInvocationResult",
"properties": {
"explanation": {
"description": "Output only. A free text explanation for the tool invocation result.",
"readOnly": true,
"type": "string"
},
"outcome": {
"description": "Output only. The outcome of the tool invocation check. This is determined by comparing the parameter_correctness_score to the threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.",
"enum": [
"OUTCOME_UNSPECIFIED",
"PASS",
"FAIL",
"SKIPPED"
],
"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."
],
"readOnly": true,
"type": "string"
},
"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.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"EvaluationResultGoldenResult": {
"description": "The result of a golden evaluation.",
"id": "EvaluationResultGoldenResult",
"properties": {
"evaluationExpectationResults": {
"description": "Output only. The results of the evaluation expectations.",
"items": {
"$ref": "EvaluationResultEvaluationExpectationResult"
},
"readOnly": true,
"type": "array"
},
"turnReplayResults": {
"description": "Output only. The result of running each turn of the golden conversation.",
"items": {
"$ref": "EvaluationResultGoldenResultTurnReplayResult"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"EvaluationResultGoldenResultTurnReplayResult": {
"description": "The result of running a single turn of the golden conversation.",
"id": "EvaluationResultGoldenResultTurnReplayResult",
"properties": {
"conversation": {
"description": "Output only. The conversation that was generated for this turn.",
"readOnly": true,
"type": "string"
},
"errorInfo": {
"$ref": "EvaluationErrorInfo",
"description": "Output only. Information about the error that occurred during this turn.",
"readOnly": true
},
"expectationOutcome": {
"description": "Output only. The outcome of each expectation.",
"items": {
"$ref": "EvaluationResultGoldenExpectationOutcome"
},
"readOnly": true,
"type": "array"
},
"hallucinationResult": {
"$ref": "EvaluationResultHallucinationResult",
"description": "Output only. The result of the hallucination check.",
"readOnly": true
},
"overallToolInvocationResult": {
"$ref": "EvaluationResultOverallToolInvocationResult",
"description": "Output only. The result of the overall tool invocation check.",
"readOnly": true
},
"semanticSimilarityResult": {
"$ref": "EvaluationResultSemanticSimilarityResult",
"description": "Output only. The result of the semantic similarity check.",
"readOnly": true
},
"spanLatencies": {
"description": "Output only. The latency of spans in the turn.",
"items": {
"$ref": "EvaluationResultSpanLatency"
},
"readOnly": true,
"type": "array"
},
"toolCallLatencies": {
"description": "Output only. The latency of each tool call in the turn.",
"items": {
"$ref": "EvaluationResultToolCallLatency"
},
"readOnly": true,
"type": "array"
},
"toolInvocationScore": {
"deprecated": true,
"description": "Output only. Deprecated. Use OverallToolInvocationResult instead.",
"format": "float",
"readOnly": true,
"type": "number"
},
"toolOrderedInvocationScore": {
"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.",
"format": "float",
"readOnly": true,
"type": "number"
},
"turnLatency": {
"description": "Output only. Duration of the turn.",
"format": "google-duration",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EvaluationResultHallucinationResult": {
"description": "The result of the hallucination check for a single turn.",
"id": "EvaluationResultHallucinationResult",
"properties": {
"explanation": {
"description": "Output only. The explanation for the hallucination score.",
"readOnly": true,
"type": "string"
},
"label": {
"description": "Output only. The label associated with each score. Score 1: Justified Score 0: Not Justified Score -1: No Claim To Assess",
"readOnly": true,
"type": "string"
},
"score": {
"description": "Output only. The hallucination score. Can be -1, 0, 1.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"EvaluationResultOverallToolInvocationResult": {
"description": "The result of the overall tool invocation check.",
"id": "EvaluationResultOverallToolInvocationResult",
"properties": {
"outcome": {
"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.",
"enum": [
"OUTCOME_UNSPECIFIED",
"PASS",
"FAIL",
"SKIPPED"
],
"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."
],
"readOnly": true,
"type": "string"
},
"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"
}
},
"type": "object"
},
"EvaluationResultScenarioExpectationOutcome": {
"description": "The outcome of a scenario expectation.",
"id": "EvaluationResultScenarioExpectationOutcome",
"properties": {
"expectation": {
"$ref": "EvaluationScenarioExpectation",
"description": "Output only. The expectation that was evaluated.",
"readOnly": true
},
"observedAgentResponse": {
"$ref": "Message",
"description": "Output only. The observed agent response.",
"readOnly": true
},
"observedToolCall": {
"$ref": "EvaluationResultScenarioExpectationOutcomeObservedToolCall",
"description": "Output only. The observed tool call.",
"readOnly": true
},
"outcome": {
"description": "Output only. The outcome of the ScenarioExpectation.",
"enum": [
"OUTCOME_UNSPECIFIED",
"PASS",
"FAIL",
"SKIPPED"
],
"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."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EvaluationResultScenarioExpectationOutcomeObservedToolCall": {
"description": "The observed tool call and response.",
"id": "EvaluationResultScenarioExpectationOutcomeObservedToolCall",
"properties": {
"toolCall": {
"$ref": "ToolCall",
"description": "Output only. The observed tool call.",
"readOnly": true
},
"toolResponse": {
"$ref": "ToolResponse",
"description": "Output only. The observed tool response.",
"readOnly": true
}
},
"type": "object"
},
"EvaluationResultScenarioResult": {
"description": "The outcome of a scenario evaluation.",
"id": "EvaluationResultScenarioResult",
"properties": {
"allExpectationsSatisfied": {
"description": "Output only. Whether all expectations were satisfied for this turn.",
"readOnly": true,
"type": "boolean"
},
"conversation": {
"description": "Output only. The conversation that was generated in the scenario.",
"readOnly": true,
"type": "string"
},
"evaluationExpectationResults": {
"description": "Output only. The results of the evaluation expectations.",
"items": {
"$ref": "EvaluationResultEvaluationExpectationResult"
},
"readOnly": true,
"type": "array"
},
"expectationOutcomes": {
"description": "Output only. The outcome of each expectation.",
"items": {
"$ref": "EvaluationResultScenarioExpectationOutcome"
},
"readOnly": true,
"type": "array"
},
"hallucinationResult": {
"description": "Output only. The result of the hallucination check. There will be one hallucination result for each turn in the conversation.",
"items": {
"$ref": "EvaluationResultHallucinationResult"
},
"readOnly": true,
"type": "array"
},
"rubricOutcomes": {
"description": "Output only. The outcome of the rubric.",
"items": {
"$ref": "EvaluationResultScenarioRubricOutcome"
},
"readOnly": true,
"type": "array"
},
"spanLatencies": {
"description": "Output only. The latency of spans in the conversation.",
"items": {
"$ref": "EvaluationResultSpanLatency"
},
"readOnly": true,
"type": "array"
},
"task": {
"description": "Output only. The task that was used when running the scenario for this result.",
"readOnly": true,
"type": "string"
},
"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": {
"$ref": "EvaluationResultTaskCompletionResult",
"deprecated": true,
"description": "Output only. The result of the task completion check.",
"readOnly": true
},
"toolCallLatencies": {
"description": "Output only. The latency of each tool call execution in the conversation.",
"items": {
"$ref": "EvaluationResultToolCallLatency"
},
"readOnly": true,
"type": "array"
},
"userFacts": {
"description": "Output only. The user facts that were used by the scenario for this result.",
"items": {
"$ref": "EvaluationScenarioUserFact"
},
"readOnly": true,
"type": "array"
},
"userGoalSatisfactionResult": {
"$ref": "EvaluationResultUserGoalSatisfactionResult",
"description": "Output only. The result of the user goal satisfaction check.",
"readOnly": true
}
},
"type": "object"
},
"EvaluationResultScenarioRubricOutcome": {
"description": "The outcome of the evaluation against the rubric.",
"id": "EvaluationResultScenarioRubricOutcome",
"properties": {
"rubric": {
"description": "Output only. The rubric that was used to evaluate the conversation.",
"readOnly": true,
"type": "string"
},
"score": {
"description": "Output only. The score of the conversation against the rubric.",
"format": "float",
"readOnly": true,
"type": "number"
},
"scoreExplanation": {
"description": "Output only. The rater's response to the rubric.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EvaluationResultSemanticSimilarityResult": {
"description": "The result of the semantic similarity check.",
"id": "EvaluationResultSemanticSimilarityResult",
"properties": {
"explanation": {
"description": "Output only. The explanation for the semantic similarity score.",
"readOnly": true,
"type": "string"
},
"label": {
"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",
"readOnly": true,
"type": "string"
},
"outcome": {
"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.",
"enum": [
"OUTCOME_UNSPECIFIED",
"PASS",
"FAIL",
"SKIPPED"
],
"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."
],
"readOnly": true,
"type": "string"
},
"score": {
"description": "Output only. The semantic similarity score. Can be 0, 1, 2, 3, or 4.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"EvaluationResultSpanLatency": {
"description": "The latency of a span execution.",
"id": "EvaluationResultSpanLatency",
"properties": {
"callback": {
"description": "Output only. The name of the user callback span.",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Output only. The display name of the span. Applicable to tool and guardrail spans.",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The end time of span.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"executionLatency": {
"description": "Output only. The latency of span.",
"format": "google-duration",
"readOnly": true,
"type": "string"
},
"model": {
"description": "Output only. The name of the LLM span.",
"readOnly": true,
"type": "string"
},
"resource": {
"description": "Output only. The resource name of the guardrail or tool spans.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Output only. The start time of span.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"toolset": {
"$ref": "ToolsetTool",
"description": "Output only. The toolset tool identifier.",
"readOnly": true
},
"type": {
"description": "Output only. The type of span.",
"enum": [
"TYPE_UNSPECIFIED",
"TOOL",
"USER_CALLBACK",
"GUARDRAIL",
"LLM"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Tool call span.",
"User callback span.",
"Guardrail span.",
"LLM span."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EvaluationResultTaskCompletionResult": {
"description": "The result of the task completion check for the conversation.",
"id": "EvaluationResultTaskCompletionResult",
"properties": {
"explanation": {
"description": "Output only. The explanation for the task completion score.",
"readOnly": true,
"type": "string"
},
"label": {
"description": "Output only. The label associated with each score. Score 1: Task Completed Score 0: Task Not Completed Score -1: User Goal Undefined",
"readOnly": true,
"type": "string"
},
"score": {
"description": "Output only. The task completion score. Can be -1, 0, 1",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"EvaluationResultToolCallLatency": {
"description": "The latency of a tool call execution.",
"id": "EvaluationResultToolCallLatency",
"properties": {
"displayName": {
"description": "Output only. The display name of the tool.",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The end time of the tool call execution.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"executionLatency": {
"description": "Output only. The latency of the tool call execution.",
"format": "google-duration",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Output only. The start time of the tool call execution.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"tool": {
"description": "Output only. The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EvaluationResultUserGoalSatisfactionResult": {
"description": "The result of a user goal satisfaction check for a conversation.",
"id": "EvaluationResultUserGoalSatisfactionResult",
"properties": {
"explanation": {
"description": "Output only. The explanation for the user task satisfaction score.",
"readOnly": true,
"type": "string"
},
"label": {
"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,
"type": "string"
},
"score": {
"description": "Output only. The user task satisfaction score. Can be -1, 0, 1.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"EvaluationRun": {
"description": "An evaluation run represents an all the evaluation results from an evaluation execution.",
"id": "EvaluationRun",
"properties": {
"appVersion": {
"description": "Output only. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`",
"readOnly": true,
"type": "string"
},
"appVersionDisplayName": {
"description": "Output only. The display name of the `app_version` that the evaluation ran against.",
"readOnly": true,
"type": "string"
},
"changelog": {
"description": "Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.",
"readOnly": true,
"type": "string"
},
"changelogCreateTime": {
"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.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"config": {
"$ref": "EvaluationConfig",
"description": "Output only. The configuration used in the run.",
"readOnly": true
},
"createTime": {
"description": "Output only. Timestamp when the evaluation run was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Optional. User-defined display name of the evaluation run. default: \" run - \".",
"type": "string"
},
"error": {
"$ref": "Status",
"deprecated": true,
"description": "Output only. Deprecated: Use error_info instead. Errors encountered during execution.",
"readOnly": true
},
"errorInfo": {
"$ref": "EvaluationErrorInfo",
"description": "Output only. Error information for the evaluation run.",
"readOnly": true
},
"evaluationDataset": {
"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,
"type": "string"
},
"evaluationResults": {
"description": "Output only. The evaluation results that are part of this run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"evaluationRunSummaries": {
"additionalProperties": {
"$ref": "EvaluationRunEvaluationRunSummary"
},
"description": "Output only. Map of evaluation name to EvaluationRunSummary.",
"readOnly": true,
"type": "object"
},
"evaluationType": {
"description": "Output only. The type of the evaluations in this run.",
"enum": [
"EVALUATION_TYPE_UNSPECIFIED",
"GOLDEN",
"SCENARIO",
"MIXED"
],
"enumDescriptions": [
"Evaluation type is not specified.",
"Golden evaluation.",
"Scenario evaluation.",
"Indicates the run includes a mix of golden and scenario evaluations."
],
"readOnly": true,
"type": "string"
},
"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}`",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"goldenRunMethod": {
"description": "Output only. The method used to run the evaluation.",
"enum": [
"GOLDEN_RUN_METHOD_UNSPECIFIED",
"STABLE",
"NAIVE"
],
"enumDescriptions": [
"Run method is not specified.",
"Run the evaluation as stable replay, where each turn is a unique session with the previous expected turns injected as context.",
"Run the evaluation as naive replay, where the run is a single session with no context injected."
],
"readOnly": true,
"type": "string"
},
"initiatedBy": {
"description": "Output only. The user who initiated the evaluation run.",
"readOnly": true,
"type": "string"
},
"latencyReport": {
"$ref": "LatencyReport",
"description": "Output only. Latency report for the evaluation run.",
"readOnly": true
},
"name": {
"description": "Identifier. The unique identifier of the evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`",
"type": "string"
},
"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."
},
"personaRunConfigs": {
"description": "Output only. The configuration to use for the run per persona.",
"items": {
"$ref": "PersonaRunConfig"
},
"readOnly": true,
"type": "array"
},
"progress": {
"$ref": "EvaluationRunProgress",
"description": "Output only. The progress of the evaluation run.",
"readOnly": true
},
"runCount": {
"description": "Output only. The number of times the evaluations inside the run were run.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"scheduledEvaluationRun": {
"description": "Output only. The scheduled evaluation run resource name that created this evaluation run. This field is only set if the evaluation run was created by a scheduled evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}`",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The state of the evaluation run.",
"enum": [
"EVALUATION_RUN_STATE_UNSPECIFIED",
"RUNNING",
"COMPLETED",
"ERROR"
],
"enumDescriptions": [
"Evaluation run state is not specified.",
"Evaluation run is running.",
"Evaluation run has completed.",
"The evaluation run has an error."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EvaluationRunEvaluationRunSummary": {
"description": "Contains the summary of passed and failed result counts for a specific evaluation in an evaluation run.",
"id": "EvaluationRunEvaluationRunSummary",
"properties": {
"errorCount": {
"description": "Output only. Number of error results for the associated Evaluation in this run.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"failedCount": {
"description": "Output only. Number of failed results for the associated Evaluation in this run.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"passedCount": {
"description": "Output only. Number of passed results for the associated Evaluation in this run.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"EvaluationRunProgress": {
"description": "The progress of the evaluation run.",
"id": "EvaluationRunProgress",
"properties": {
"completedCount": {
"description": "Output only. Number of evaluation results that finished successfully. (EvaluationResult.execution_state is COMPLETED).",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"errorCount": {
"description": "Output only. Number of evaluation results that failed to execute. (EvaluationResult.execution_state is ERROR).",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"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).",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"passedCount": {
"description": "Output only. Number of completed evaluation results with an outcome of PASS. (EvaluationResult.execution_state is COMPLETED and EvaluationResult.evaluation_status is PASS).",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"totalCount": {
"description": "Output only. Total number of evaluation results in this run.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"EvaluationScenario": {
"description": "The config for a scenario",
"id": "EvaluationScenario",
"properties": {
"evaluationExpectations": {
"description": "Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}`",
"items": {
"type": "string"
},
"type": "array"
},
"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"
},
"rubrics": {
"description": "Required. The rubrics to score the scenario against.",
"items": {
"type": "string"
},
"type": "array"
},
"scenarioExpectations": {
"description": "Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation.",
"items": {
"$ref": "EvaluationScenarioExpectation"
},
"type": "array"
},
"task": {
"description": "Required. The task to be targeted by the scenario.",
"type": "string"
},
"taskCompletionBehavior": {
"deprecated": true,
"description": "Optional. Deprecated. Use user_goal_behavior instead.",
"enum": [
"TASK_COMPLETION_BEHAVIOR_UNSPECIFIED",
"TASK_SATISFIED",
"TASK_REJECTED"
],
"enumDescriptions": [
"Behavior unspecified. Will default to TASK_SATISFIED.",
"The user task should be completed successfully.",
"The user task should be rejected."
],
"type": "string"
},
"userFacts": {
"description": "Optional. The user facts to be used by the scenario.",
"items": {
"$ref": "EvaluationScenarioUserFact"
},
"type": "array"
},
"userGoalBehavior": {
"description": "Optional. The expected behavior of the user goal.",
"enum": [
"USER_GOAL_BEHAVIOR_UNSPECIFIED",
"USER_GOAL_SATISFIED",
"USER_GOAL_REJECTED",
"USER_GOAL_IGNORED"
],
"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."
],
"type": "string"
},
"variableOverrides": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"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"
}
},
"type": "object"
},
"EvaluationScenarioExpectation": {
"description": "The expectation to evaluate the conversation produced by the simulation.",
"id": "EvaluationScenarioExpectation",
"properties": {
"agentResponse": {
"$ref": "Message",
"description": "Optional. The agent response to be evaluated."
},
"toolExpectation": {
"$ref": "EvaluationScenarioExpectationToolExpectation",
"description": "Optional. The tool call and response pair to be evaluated."
}
},
"type": "object"
},
"EvaluationScenarioExpectationToolExpectation": {
"description": "The tool call and response pair to be evaluated.",
"id": "EvaluationScenarioExpectationToolExpectation",
"properties": {
"expectedToolCall": {
"$ref": "ToolCall",
"description": "Required. The expected tool call, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM."
},
"mockToolResponse": {
"$ref": "ToolResponse",
"description": "Required. The tool response to mock, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM."
}
},
"type": "object"
},
"EvaluationScenarioUserFact": {
"description": "Facts about the user as a key value pair.",
"id": "EvaluationScenarioUserFact",
"properties": {
"name": {
"description": "Required. The name of the user fact.",
"type": "string"
},
"value": {
"description": "Required. The value of the user fact.",
"type": "string"
}
},
"type": "object"
},
"EvaluationSettings": {
"description": "Settings for evaluation.",
"id": "EvaluationSettings",
"properties": {
"goldenEvaluationToolCallBehaviour": {
"description": "Optional. Configures the default tool call behaviour for golden evaluations.",
"enum": [
"EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED",
"REAL",
"FAKE"
],
"enumDescriptions": [
"Unspecified tool call behavior. Will default to real tool calls.",
"Use real tool calls.",
"Use fake tool calls."
],
"type": "string"
},
"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.",
"enum": [
"GOLDEN_RUN_METHOD_UNSPECIFIED",
"STABLE",
"NAIVE"
],
"enumDescriptions": [
"Run method is not specified.",
"Run the evaluation as stable replay, where each turn is a unique session with the previous expected turns injected as context.",
"Run the evaluation as naive replay, where the run is a single session with no context injected."
],
"type": "string"
},
"scenarioConversationInitiator": {
"description": "Optional. Who starts the conversation in a scenario evaluation.",
"enum": [
"SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED",
"USER",
"AGENT"
],
"enumDescriptions": [
"Unspecified. Defaults to USER.",
"The user starts the conversation.",
"The agent starts the conversation."
],
"type": "string"
},
"scenarioEvaluationToolCallBehaviour": {
"description": "Optional. Configures the default tool call behaviour for scenario evaluations.",
"enum": [
"EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED",
"REAL",
"FAKE"
],
"enumDescriptions": [
"Unspecified tool call behavior. Will default to real tool calls.",
"Use real tool calls.",
"Use fake tool calls."
],
"type": "string"
}
},
"type": "object"
},
"EvaluationStep": {
"description": "A step defines a singular action to happen during the evaluation.",
"id": "EvaluationStep",
"properties": {
"agentTransfer": {
"$ref": "AgentTransfer",
"description": "Optional. Transfer the conversation to a different agent."
},
"expectation": {
"$ref": "EvaluationGoldenExpectation",
"description": "Optional. Executes an expectation on the current turn."
},
"userInput": {
"$ref": "SessionInput",
"description": "Optional. User input for the conversation."
}
},
"type": "object"
},
"Event": {
"description": "Event input.",
"id": "Event",
"properties": {
"event": {
"description": "Required. The name of the event.",
"type": "string"
}
},
"type": "object"
},
"Example": {
"description": "An example represents a sample conversation between the user and the agent(s).",
"id": "Example",
"properties": {
"createTime": {
"description": "Output only. Timestamp when the example was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Human-readable description of the example.",
"type": "string"
},
"displayName": {
"description": "Required. Display name of the example.",
"type": "string"
},
"entryAgent": {
"description": "Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
"type": "string"
},
"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"
},
"invalid": {
"description": "Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.",
"readOnly": true,
"type": "boolean"
},
"messages": {
"description": "Optional. The collection of messages that make up the conversation.",
"items": {
"$ref": "Message"
},
"type": "array"
},
"name": {
"description": "Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`",
"type": "string"
},
"updateTime": {
"description": "Output only. Timestamp when the example was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ExecuteToolRequest": {
"description": "Request message for ToolService.ExecuteTool.",
"id": "ExecuteToolRequest",
"properties": {
"args": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The input parameters and values for the tool in JSON object format.",
"type": "object"
},
"context": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"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"
},
"mockConfig": {
"$ref": "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."
},
"tool": {
"description": "Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}",
"type": "string"
},
"toolsetTool": {
"$ref": "ToolsetTool",
"description": "Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned."
},
"variables": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The variables that are available for the tool execution.",
"type": "object"
}
},
"type": "object"
},
"ExecuteToolResponse": {
"description": "Response message for ToolService.ExecuteTool.",
"id": "ExecuteToolResponse",
"properties": {
"response": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"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"
},
"tool": {
"description": "The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`",
"type": "string"
},
"toolsetTool": {
"$ref": "ToolsetTool",
"description": "The toolset tool that got executed."
},
"variables": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The variable values at the end of the tool execution.",
"type": "object"
}
},
"type": "object"
},
"ExperimentConfig": {
"description": "Experiment for the deployment.",
"id": "ExperimentConfig",
"properties": {
"versionRelease": {
"$ref": "ExperimentConfigVersionRelease",
"description": "Optional. Version release for the experiment."
}
},
"type": "object"
},
"ExperimentConfigVersionRelease": {
"description": "Version release for the experiment.",
"id": "ExperimentConfigVersionRelease",
"properties": {
"state": {
"description": "Optional. State of the version release.",
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"RUNNING",
"DONE",
"EXPIRED"
],
"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."
],
"type": "string"
},
"trafficAllocations": {
"description": "Optional. Traffic allocations for the version release.",
"items": {
"$ref": "ExperimentConfigVersionReleaseTrafficAllocation"
},
"type": "array"
}
},
"type": "object"
},
"ExperimentConfigVersionReleaseTrafficAllocation": {
"description": "Traffic allocation for the version release.",
"id": "ExperimentConfigVersionReleaseTrafficAllocation",
"properties": {
"appVersion": {
"description": "Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`",
"type": "string"
},
"id": {
"description": "Optional. Id of the traffic allocation. Free format string, up to 128 characters.",
"type": "string"
},
"trafficPercentage": {
"description": "Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ExportAppRequest": {
"description": "Request message for AgentService.ExportApp.",
"id": "ExportAppRequest",
"properties": {
"appVersion": {
"description": "Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`.",
"type": "string"
},
"exportFormat": {
"description": "Required. The format to export the app in.",
"enum": [
"EXPORT_FORMAT_UNSPECIFIED",
"JSON",
"YAML"
],
"enumDescriptions": [
"The export format is unspecified.",
"The export format is JSON.",
"The export format is YAML."
],
"type": "string"
},
"gcsUri": {
"description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified GCS object.",
"type": "string"
}
},
"type": "object"
},
"ExportAppResponse": {
"description": "Response message for AgentService.ExportApp.",
"id": "ExportAppResponse",
"properties": {
"appContent": {
"description": "App folder compressed as a zip file.",
"format": "byte",
"type": "string"
},
"appUri": {
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which the app was exported.",
"type": "string"
}
},
"type": "object"
},
"ExportEvaluationResultsResponse": {
"description": "Response message for EvaluationService.ExportEvaluationResults.",
"id": "ExportEvaluationResultsResponse",
"properties": {
"evaluationResultsContent": {
"description": "The content of the exported Evaluation Results. This will be populated if gcs_uri was not specified in the request.",
"format": "byte",
"type": "string"
},
"evaluationResultsUri": {
"description": "The Google Cloud Storage URI folder where the exported Evaluation Results were written. This will be populated if gcs_uri was specified in the request.",
"type": "string"
}
},
"type": "object"
},
"ExportEvaluationRunsResponse": {
"description": "Response message for EvaluationService.ExportEvaluationRuns.",
"id": "ExportEvaluationRunsResponse",
"properties": {
"evaluationRunsContent": {
"description": "The content of the exported Evaluation Runs. This will be populated if gcs_uri was not specified in the request.",
"format": "byte",
"type": "string"
},
"evaluationRunsUri": {
"description": "The Google Cloud Storage URI folder where the exported Evaluation Runs were written. This will be populated if gcs_uri was specified in the request.",
"type": "string"
}
},
"type": "object"
},
"ExportEvaluationsRequest": {
"description": "Request message for EvaluationService.ExportEvaluations.",
"id": "ExportEvaluationsRequest",
"properties": {
"exportOptions": {
"$ref": "ExportOptions",
"description": "Optional. The export options for the evaluations."
},
"includeEvaluationResults": {
"description": "Optional. Includes evaluation results in the export. At least one of include_evaluation_results or include_evaluations must be set.",
"type": "boolean"
},
"includeEvaluations": {
"description": "Optional. Includes evaluations in the export. At least one of include_evaluation_results or include_evaluations must be set.",
"type": "boolean"
},
"names": {
"description": "Required. The resource names of the evaluations to export.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ExportEvaluationsResponse": {
"description": "Response message for EvaluationService.ExportEvaluations.",
"id": "ExportEvaluationsResponse",
"properties": {
"evaluationsContent": {
"description": "The content of the exported Evaluations. This will be populated if gcs_uri was not specified in the request.",
"format": "byte",
"type": "string"
},
"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": {
"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,
"type": "object"
}
},
"type": "object"
},
"ExportOptions": {
"description": "Options for exporting CES evaluation resources.",
"id": "ExportOptions",
"properties": {
"exportFormat": {
"description": "Optional. The format to export the evaluation results in. Defaults to JSON if not specified.",
"enum": [
"EXPORT_FORMAT_UNSPECIFIED",
"JSON",
"YAML"
],
"enumDescriptions": [
"Unspecified format.",
"JSON format.",
"YAML format."
],
"type": "string"
},
"gcsUri": {
"description": "Optional. The Google Cloud Storage URI to write the exported Evaluation Results to.",
"type": "string"
}
},
"type": "object"
},
"ExpressionCondition": {
"description": "Expression condition based on session state.",
"id": "ExpressionCondition",
"properties": {
"expression": {
"description": "Required. The string representation of cloud.api.Expression condition.",
"type": "string"
}
},
"type": "object"
},
"FileContext": {
"description": "Files to be used as context. Files can be provided as raw bytes.",
"id": "FileContext",
"properties": {
"fileBytes": {
"$ref": "FileContextFileBytes",
"description": "Optional. File provided as raw bytes."
}
},
"type": "object"
},
"FileContextFileBytes": {
"description": "File provided as raw bytes.",
"id": "FileContextFileBytes",
"properties": {
"data": {
"description": "Required. Raw bytes of the file.",
"format": "byte",
"type": "string"
},
"fileName": {
"description": "Required. The name of the file provided as raw bytes.",
"type": "string"
},
"mimeType": {
"description": "Required. The IANA standard MIME type of the source data.",
"type": "string"
}
},
"type": "object"
},
"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",
"properties": {
"corpusType": {
"description": "Optional. The type of the corpus. Default is FULLY_MANAGED.",
"enum": [
"CORPUS_TYPE_UNSPECIFIED",
"USER_OWNED",
"FULLY_MANAGED"
],
"enumDescriptions": [
"Unspecified corpus type.",
"The corpus is created and owned by the user.",
"The corpus is created by the agent."
],
"type": "string"
},
"description": {
"description": "Optional. The tool description.",
"type": "string"
},
"fileCorpus": {
"description": "Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}",
"type": "string"
},
"name": {
"description": "Required. The tool name.",
"type": "string"
}
},
"type": "object"
},
"GenerateAppResourceRequest": {
"description": "Request message for AgentService.GenerateAppResource.",
"id": "GenerateAppResourceRequest",
"properties": {
"agent": {
"$ref": "Agent",
"description": "The agent resource to be used by the LLM assistant, can be empty for generating a new agent."
},
"appGenerationConfig": {
"$ref": "GenerateAppResourceRequestAppGenerationConfig",
"description": "Optional. The configuration to be used to generate the agents and tools."
},
"evaluationGenerationConfig": {
"$ref": "GenerateAppResourceRequestEvaluationGenerationConfig",
"description": "Optional. The configuration to be used to generate the evaluations."
},
"evaluationPersonasGenerationConfig": {
"$ref": "GenerateAppResourceRequestEvaluationPersonasGenerationConfig",
"description": "Optional. The configuration to be used to generate the evaluation personas."
},
"hillClimbingFixConfig": {
"$ref": "GenerateAppResourceRequestHillClimbingFixConfig",
"description": "Optional. The configuration to be used for hill climbing fixes."
},
"qualityReportGenerationConfig": {
"$ref": "GenerateAppResourceRequestQualityReportGenerationConfig",
"description": "Optional. The configuration to be used for quality report generation."
},
"refineInstructions": {
"description": "Optional. List of refine instructions to be used to refine the resource.",
"items": {
"$ref": "GenerateAppResourceRequestRefineInstructions"
},
"type": "array"
},
"tool": {
"$ref": "Tool",
"description": "The tool resource to be used by the LLM assistant, can be empty for generating a new tool."
},
"toolGenerationConfig": {
"$ref": "GenerateAppResourceRequestToolGenerationConfig",
"description": "Optional. The configuration to be used to generate the tool."
},
"toolset": {
"$ref": "Toolset",
"description": "The toolset resource to be used by the LLM assistant, can be empty for generating a new toolset."
}
},
"type": "object"
},
"GenerateAppResourceRequestAppGenerationConfig": {
"description": "The configuration to be used to generate the app.",
"id": "GenerateAppResourceRequestAppGenerationConfig",
"properties": {
"context": {
"description": "Optional. The context which describes the requirements of the agents & tools to be generated.",
"type": "string"
},
"datasetId": {
"description": "Optional. The insights dataset to be used to fetch conversation data for generating the agents & tools. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.",
"type": "string"
},
"fileContexts": {
"description": "Optional. The files to be used as context.",
"items": {
"$ref": "FileContext"
},
"type": "array"
},
"gcsLocation": {
"description": "Optional. The Cloud Storage location to store the generated question answer data to be used by the Datastore tool. This data is generated only when using conversation data as an input source. The location must be in the same project as the app. Format: `gs://...`.",
"type": "string"
},
"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"
}
},
"type": "object"
},
"GenerateAppResourceRequestEvaluationGenerationConfig": {
"description": "The configuration to be used to generate the evaluations.",
"id": "GenerateAppResourceRequestEvaluationGenerationConfig",
"properties": {
"datasetId": {
"description": "Optional. The insights dataset to be used to fetch conversation data for generating the evaluations. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.",
"type": "string"
}
},
"type": "object"
},
"GenerateAppResourceRequestEvaluationPersonasGenerationConfig": {
"description": "The configuration to be used to generate the evaluation personas.",
"id": "GenerateAppResourceRequestEvaluationPersonasGenerationConfig",
"properties": {},
"type": "object"
},
"GenerateAppResourceRequestHillClimbingFixConfig": {
"description": "The configuration to be used for hill climbing fixes.",
"id": "GenerateAppResourceRequestHillClimbingFixConfig",
"properties": {
"qualityReport": {
"$ref": "QualityReport",
"description": "Required. The quality report used to inform the instruction following fix."
}
},
"type": "object"
},
"GenerateAppResourceRequestQualityReportGenerationConfig": {
"description": "The configuration to be used for quality report generation.",
"id": "GenerateAppResourceRequestQualityReportGenerationConfig",
"properties": {
"evaluationRun": {
"description": "Required. The evaluation run used to inform quality report analysis.",
"type": "string"
}
},
"type": "object"
},
"GenerateAppResourceRequestRefineInstructions": {
"description": "The instructions to be used to refine a part of the resource. The part of the resource can be specified with a start index, end index and a field mask. For example, if you want to refine a part of the agent instructions you can specify the index of the first character of the instructions, the index of the last character of the instructions and the field mask as \"instructions\".",
"id": "GenerateAppResourceRequestRefineInstructions",
"properties": {
"endIndex": {
"description": "Required. The last character (inclusive) of the text to refine.",
"format": "int64",
"type": "string"
},
"fieldMask": {
"description": "Required. The field of the resource being refined. Only one field is allowed per RefineInstructions. If refining agent instructions, the field mask should be \"instructions\".",
"format": "google-fieldmask",
"type": "string"
},
"instructions": {
"description": "Required. The instructions to refine the resource.",
"type": "string"
},
"startIndex": {
"description": "Required. The first character (inclusive) of the text to refine.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GenerateAppResourceRequestToolGenerationConfig": {
"description": "The configuration to be used to generate a tool.",
"id": "GenerateAppResourceRequestToolGenerationConfig",
"properties": {
"context": {
"description": "Optional. The context which describes the tool to be generated. This can be empty if the tool request & response are provided.",
"type": "string"
},
"fileContexts": {
"description": "Optional. The files to be used as context.",
"items": {
"$ref": "FileContext"
},
"type": "array"
},
"openApiToolsetGenerationConfig": {
"$ref": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig",
"description": "Optional. The configuration to be used to generate an Open API schema."
}
},
"type": "object"
},
"GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig": {
"description": "The configuration to be used to generate an Open API schema.",
"id": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig",
"properties": {
"operationGenerationConfigs": {
"description": "Required. The list of operations to be added to the Open API schema.",
"items": {
"$ref": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig"
},
"type": "array"
},
"uri": {
"description": "Required. The base uri of the tool.",
"type": "string"
}
},
"type": "object"
},
"GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig": {
"description": "The configuration to be used to generate an operation in the Open API schema.",
"id": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig",
"properties": {
"method": {
"description": "Required. The uri of the tool. This should include query and path parameters if any.",
"type": "string"
},
"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"
}
},
"type": "object"
},
"GenerateAppResourceResponse": {
"description": "Response message for AgentService.GenerateAppResource.",
"id": "GenerateAppResourceResponse",
"properties": {
"agent": {
"$ref": "Agent",
"description": "Agent generated by the LLM assistant."
},
"appResources": {
"$ref": "GenerateAppResourceResponseAppResources",
"description": "The app resources generated by the LLM assistant."
},
"appSnapshot": {
"$ref": "AppSnapshot",
"description": "App snapshot generated by the LLM assistant. This snapshot contains the app, agents & tools generated by the LLM assistant."
},
"evaluations": {
"$ref": "GenerateAppResourceResponseEvaluations",
"description": "Evaluations generated by the LLM assistant."
},
"generateResultInfo": {
"$ref": "GenerateAppResourceResponseGenerateResultInfo",
"description": "Additional information about the generated result."
},
"qualityReport": {
"$ref": "QualityReport",
"description": "The quality report generated by the LLM assistant."
},
"tools": {
"$ref": "GenerateAppResourceResponseTools",
"description": "The list of tools generated by the LLM assistant."
},
"toolset": {
"$ref": "Toolset",
"description": "Toolset generated by the LLM assistant. Supports Open API toolset schema generation."
}
},
"type": "object"
},
"GenerateAppResourceResponseAppResources": {
"description": "The list of app resources generated by the LLM assistant.",
"id": "GenerateAppResourceResponseAppResources",
"properties": {
"appSnapshot": {
"$ref": "AppSnapshot",
"description": "The app snapshot generated by the LLM assistant. This snapshot contains the app, agents & tools generated by the LLM assistant."
},
"evaluations": {
"description": "The list of evaluations generated by the LLM assistant.",
"items": {
"$ref": "Evaluation"
},
"type": "array"
}
},
"type": "object"
},
"GenerateAppResourceResponseEvaluations": {
"description": "The list of evaluations generated by the LLM assistant.",
"id": "GenerateAppResourceResponseEvaluations",
"properties": {
"evaluations": {
"description": "The list of generated evaluations.",
"items": {
"$ref": "Evaluation"
},
"type": "array"
}
},
"type": "object"
},
"GenerateAppResourceResponseGenerateResultInfo": {
"description": "This provides additional information about the generated result.",
"id": "GenerateAppResourceResponseGenerateResultInfo",
"properties": {
"explanation": {
"description": "An explanation of the changes in the generated resource.",
"type": "string"
}
},
"type": "object"
},
"GenerateAppResourceResponseTools": {
"description": "The list of tools generated by the LLM assistant.",
"id": "GenerateAppResourceResponseTools",
"properties": {
"tools": {
"description": "The list of tools generated by the LLM assistant.",
"items": {
"$ref": "Tool"
},
"type": "array"
}
},
"type": "object"
},
"GenerateChatTokenRequest": {
"description": "Request message for WidgetService.GenerateChatToken.",
"id": "GenerateChatTokenRequest",
"properties": {
"deployment": {
"description": "Required. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}",
"type": "string"
},
"liveHandoffEnabled": {
"description": "Optional. Indicates if live handoff is enabled for the session.",
"type": "boolean"
},
"recaptchaToken": {
"description": "Optional. The reCAPTCHA token generated by the client-side chat widget.",
"type": "string"
}
},
"type": "object"
},
"GenerateChatTokenResponse": {
"description": "Response message for WidgetService.GenerateChatToken.",
"id": "GenerateChatTokenResponse",
"properties": {
"chatToken": {
"description": "The session scoped token for chat widget to authenticate with Session APIs.",
"type": "string"
},
"expireTime": {
"description": "The time at which the chat token expires.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GenerateEvaluationOperationMetadata": {
"description": "Operation metadata for EvaluationService.GenerateEvaluation.",
"id": "GenerateEvaluationOperationMetadata",
"properties": {},
"type": "object"
},
"GenerateEvaluationRequest": {
"description": "Request message for EvaluationService.GenerateEvaluation.",
"id": "GenerateEvaluationRequest",
"properties": {
"source": {
"deprecated": true,
"description": "Optional. Indicate the source of the conversation. If not set, all sources will be searched.",
"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."
],
"type": "string"
}
},
"type": "object"
},
"GoogleSearchSuggestions": {
"description": "Search suggestions from Google Search Tool.",
"id": "GoogleSearchSuggestions",
"properties": {
"htmls": {
"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)`.",
"items": {
"type": "string"
},
"type": "array"
},
"webSearchQueries": {
"description": "List of queries used to perform the google search along with the search result URIs forming the search suggestions.",
"items": {
"$ref": "WebSearchQuery"
},
"type": "array"
}
},
"type": "object"
},
"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",
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "Optional. Description of the tool's purpose.",
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Required. The name of the tool.",
"type": "string"
},
"preferredDomains": {
"description": "Optional. Specifies domains to restrict search results to. Example: \"example.com\", \"another.site\". A maximum of 20 domains can be specified.",
"items": {
"type": "string"
},
"type": "array"
},
"promptConfig": {
"$ref": "GoogleSearchToolPromptConfig",
"description": "Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice."
}
},
"type": "object"
},
"GoogleSearchToolPromptConfig": {
"description": "Prompt settings used by the model when processing or summarizing the google search results.",
"id": "GoogleSearchToolPromptConfig",
"properties": {
"textPrompt": {
"description": "Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.",
"type": "string"
},
"voicePrompt": {
"description": "Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.",
"type": "string"
}
},
"type": "object"
},
"Guardrail": {
"description": "Guardrail contains a list of checks and balances to keep the agents safe and secure.",
"id": "Guardrail",
"properties": {
"action": {
"$ref": "TriggerAction",
"description": "Optional. Action to take when the guardrail is triggered."
},
"codeCallback": {
"$ref": "GuardrailCodeCallback",
"description": "Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution."
},
"contentFilter": {
"$ref": "GuardrailContentFilter",
"description": "Optional. Guardrail that bans certain content from being used in the conversation."
},
"createTime": {
"description": "Output only. Timestamp when the guardrail was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Description of the guardrail.",
"type": "string"
},
"displayName": {
"description": "Required. Display name of the guardrail.",
"type": "string"
},
"enabled": {
"description": "Optional. Whether the guardrail is enabled.",
"type": "boolean"
},
"etag": {
"description": "Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.",
"type": "string"
},
"llmPolicy": {
"$ref": "GuardrailLlmPolicy",
"description": "Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification."
},
"llmPromptSecurity": {
"$ref": "GuardrailLlmPromptSecurity",
"description": "Optional. Guardrail that blocks the conversation if the prompt is considered unsafe based on the LLM classification."
},
"modelSafety": {
"$ref": "GuardrailModelSafety",
"description": "Optional. Guardrail that blocks the conversation if the LLM response is considered unsafe based on the model safety settings."
},
"name": {
"description": "Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`",
"type": "string"
},
"updateTime": {
"description": "Output only. Timestamp when the guardrail was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GuardrailCodeCallback": {
"description": "Guardrail that blocks the conversation based on the code callbacks provided.",
"id": "GuardrailCodeCallback",
"properties": {
"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": {
"$ref": "Callback",
"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."
},
"beforeAgentCallback": {
"$ref": "Callback",
"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."
},
"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."
}
},
"type": "object"
},
"GuardrailContentFilter": {
"description": "Guardrail that bans certain content from being used in the conversation.",
"id": "GuardrailContentFilter",
"properties": {
"bannedContents": {
"description": "Optional. List of banned phrases. Applies to both user inputs and agent responses.",
"items": {
"type": "string"
},
"type": "array"
},
"bannedContentsInAgentResponse": {
"description": "Optional. List of banned phrases. Applies only to agent responses.",
"items": {
"type": "string"
},
"type": "array"
},
"bannedContentsInUserInput": {
"description": "Optional. List of banned phrases. Applies only to user inputs.",
"items": {
"type": "string"
},
"type": "array"
},
"disregardDiacritics": {
"description": "Optional. If true, diacritics are ignored during matching.",
"type": "boolean"
},
"matchType": {
"description": "Required. Match type for the content filter.",
"enum": [
"MATCH_TYPE_UNSPECIFIED",
"SIMPLE_STRING_MATCH",
"WORD_BOUNDARY_STRING_MATCH",
"REGEXP_MATCH"
],
"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."
],
"type": "string"
}
},
"type": "object"
},
"GuardrailLlmPolicy": {
"description": "Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.",
"id": "GuardrailLlmPolicy",
"properties": {
"allowShortUtterance": {
"description": "Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped.",
"type": "boolean"
},
"failOpen": {
"description": "Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.",
"type": "boolean"
},
"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"
},
"modelSettings": {
"$ref": "ModelSettings",
"description": "Optional. Model settings."
},
"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.",
"enum": [
"POLICY_SCOPE_UNSPECIFIED",
"USER_QUERY",
"AGENT_RESPONSE",
"USER_QUERY_AND_AGENT_RESPONSE"
],
"enumDescriptions": [
"Policy scope is not specified.",
"Policy check is triggered on user input.",
"Policy check is triggered on agent response. Applying this policy scope will introduce additional latency before the agent can respond.",
"Policy check is triggered on both user input and agent response. Applying this policy scope will introduce additional latency before the agent can respond."
],
"type": "string"
},
"prompt": {
"description": "Required. Policy prompt.",
"type": "string"
}
},
"type": "object"
},
"GuardrailLlmPromptSecurity": {
"description": "Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification.",
"id": "GuardrailLlmPromptSecurity",
"properties": {
"customPolicy": {
"$ref": "GuardrailLlmPolicy",
"description": "Optional. Use a user-defined LlmPolicy to configure the security guardrail."
},
"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."
},
"failOpen": {
"description": "Optional. Determines the behavior when the guardrail encounters an LLM error. - If true: the guardrail is bypassed. - If false (default): the guardrail triggers/blocks. Note: If a custom policy is provided, this field is ignored in favor of the policy's 'fail_open' configuration.",
"type": "boolean"
}
},
"type": "object"
},
"GuardrailLlmPromptSecurityDefaultSecuritySettings": {
"description": "Configuration for default system security settings.",
"id": "GuardrailLlmPromptSecurityDefaultSecuritySettings",
"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"
}
},
"type": "object"
},
"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",
"properties": {
"safetySettings": {
"description": "Required. List of safety settings.",
"items": {
"$ref": "GuardrailModelSafetySafetySetting"
},
"type": "array"
}
},
"type": "object"
},
"GuardrailModelSafetySafetySetting": {
"description": "Safety setting.",
"id": "GuardrailModelSafetySafetySetting",
"properties": {
"category": {
"description": "Required. The harm category.",
"enum": [
"HARM_CATEGORY_UNSPECIFIED",
"HARM_CATEGORY_HATE_SPEECH",
"HARM_CATEGORY_DANGEROUS_CONTENT",
"HARM_CATEGORY_HARASSMENT",
"HARM_CATEGORY_SEXUALLY_EXPLICIT"
],
"enumDescriptions": [
"The harm category is unspecified.",
"The harm category is hate speech.",
"The harm category is dangerous content.",
"The harm category is harassment.",
"The harm category is sexually explicit content."
],
"type": "string"
},
"threshold": {
"description": "Required. The harm block threshold.",
"enum": [
"HARM_BLOCK_THRESHOLD_UNSPECIFIED",
"BLOCK_LOW_AND_ABOVE",
"BLOCK_MEDIUM_AND_ABOVE",
"BLOCK_ONLY_HIGH",
"BLOCK_NONE",
"OFF"
],
"enumDescriptions": [
"Unspecified harm block threshold.",
"Block low threshold and above (i.e. block more).",
"Block medium threshold and above.",
"Block only high threshold (i.e. block less).",
"Block none.",
"Turn off the safety filter."
],
"type": "string"
}
},
"type": "object"
},
"Image": {
"description": "Represents an image input or output in the conversation.",
"id": "Image",
"properties": {
"data": {
"description": "Required. Raw bytes of the image.",
"format": "byte",
"type": "string"
},
"mimeType": {
"description": "Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp",
"type": "string"
}
},
"type": "object"
},
"ImportAppRequest": {
"description": "Request message for AgentService.ImportApp.",
"id": "ImportAppRequest",
"properties": {
"appContent": {
"description": "Raw bytes representing the compressed zip file with the app folder structure.",
"format": "byte",
"type": "string"
},
"appId": {
"description": "Optional. The ID to use for the imported app. * If not specified, a unique ID will be automatically assigned for the app. * Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced.",
"type": "string"
},
"displayName": {
"description": "Optional. The display name of the app to import. * If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique. * If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error.",
"type": "string"
},
"gcsUri": {
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI from which to import app. The format of this URI must be `gs:///`.",
"type": "string"
},
"ignoreAppLock": {
"description": "Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock.",
"type": "boolean"
},
"importOptions": {
"$ref": "ImportAppRequestImportOptions",
"description": "Optional. Options governing the import process for the app."
}
},
"type": "object"
},
"ImportAppRequestImportOptions": {
"description": "Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data.",
"id": "ImportAppRequestImportOptions",
"properties": {
"conflictResolutionStrategy": {
"description": "Optional. The strategy to use when resolving conflicts during import.",
"enum": [
"CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED",
"REPLACE",
"OVERWRITE"
],
"enumDescriptions": [
"The conflict resolution strategy is unspecified.",
"Replace existing data with imported data. If an app with the same `app_id` already exists, its content will be updated based on the imported app. - Resources (App, Agents, Tools, Examples, Guardrails, Toolsets) in the imported app that have the same display name as existing resources will overwrite the existing ones. - Imported resources with new display names will be created. - Existing resources that do not have a matching display name in the imported app will remain untouched.",
"Overwrite existing data with imported data. If an app with the same `app_id` already exists, its content will be overwritten with the imported app. - Existing resources (Agents, Tools, Examples, Guardrails, Toolsets) in the app will be deleted. - Imported resources will be created as new resources."
],
"type": "string"
}
},
"type": "object"
},
"ImportAppResponse": {
"description": "Response message for AgentService.ImportApp.",
"id": "ImportAppResponse",
"properties": {
"name": {
"description": "The resource name of the app that was imported.",
"type": "string"
},
"warnings": {
"description": "Warning messages generated during the import process. If errors occur for specific resources, they will not be included in the imported app and the error will be mentioned here.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImportEvaluationsOperationMetadata": {
"description": "Represents the metadata of the long-running operation for EvaluationService.ImportEvaluations.",
"id": "ImportEvaluationsOperationMetadata",
"properties": {
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ImportEvaluationsRequest": {
"description": "Request message for EvaluationService.ImportEvaluations.",
"id": "ImportEvaluationsRequest",
"properties": {
"conversationList": {
"$ref": "ImportEvaluationsRequestConversationList",
"description": "The conversations to import the evaluations from."
},
"csvContent": {
"description": "Raw bytes representing the csv file with the evaluations structure.",
"format": "byte",
"type": "string"
},
"gcsUri": {
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI from which to import evaluations. The format of this URI must be `gs:///`.",
"type": "string"
},
"importOptions": {
"$ref": "ImportEvaluationsRequestImportOptions",
"description": "Optional. Options governing the import process for the evaluations."
}
},
"type": "object"
},
"ImportEvaluationsRequestConversationList": {
"description": "A list of conversation resource names.",
"id": "ImportEvaluationsRequestConversationList",
"properties": {
"conversations": {
"description": "Optional. Conversation resource names.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImportEvaluationsRequestImportOptions": {
"description": "Configuration options for the evaluation import process. These options control how the import behaves, particularly when conflicts arise with existing evaluations data.",
"id": "ImportEvaluationsRequestImportOptions",
"properties": {
"conflictResolutionStrategy": {
"description": "Optional. The strategy to use when resolving conflicts during import.",
"enum": [
"CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED",
"OVERWRITE",
"SKIP",
"DUPLICATE"
],
"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."
],
"type": "string"
}
},
"type": "object"
},
"ImportEvaluationsResponse": {
"description": "Response message for EvaluationService.ImportEvaluations.",
"id": "ImportEvaluationsResponse",
"properties": {
"errorMessages": {
"description": "Optional. A list of error messages associated with evaluations that failed to be imported.",
"items": {
"type": "string"
},
"type": "array"
},
"evaluationResultImportFailureCount": {
"description": "The number of evaluation results that either failed to import entirely or completed import with one or more errors.",
"format": "int32",
"type": "integer"
},
"evaluationResults": {
"description": "The list of evaluation results that were imported into the app.",
"items": {
"$ref": "EvaluationResult"
},
"type": "array"
},
"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"
},
"evaluationRuns": {
"description": "The list of evaluation runs that were imported into the app.",
"items": {
"$ref": "EvaluationRun"
},
"type": "array"
},
"evaluations": {
"description": "The list of evaluations that were imported into the app.",
"items": {
"$ref": "Evaluation"
},
"type": "array"
},
"importFailureCount": {
"description": "The number of evaluations that either failed to import entirely or completed import with one or more errors.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"InputAudioConfig": {
"description": "InputAudioConfig configures how the CES agent should interpret the incoming audio data.",
"id": "InputAudioConfig",
"properties": {
"audioEncoding": {
"description": "Required. The encoding of the input audio data.",
"enum": [
"AUDIO_ENCODING_UNSPECIFIED",
"LINEAR16",
"MULAW",
"ALAW"
],
"enumDescriptions": [
"Unspecified audio encoding.",
"16-bit linear PCM audio encoding.",
"8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
"8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law."
],
"type": "string"
},
"noiseSuppressionLevel": {
"description": "Optional. Whether to enable noise suppression on the input audio. Available values are \"low\", \"moderate\", \"high\", \"very_high\".",
"type": "string"
},
"sampleRateHertz": {
"description": "Required. The sample rate (in Hertz) of the input audio data.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"LanguageSettings": {
"description": "Language settings of the app.",
"id": "LanguageSettings",
"properties": {
"defaultLanguageCode": {
"description": "Optional. The default language code of the app.",
"type": "string"
},
"enableMultilingualSupport": {
"description": "Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.",
"type": "boolean"
},
"fallbackAction": {
"deprecated": true,
"description": "Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as \"escalate\" or \"exit\", which triggers an EndSession signal with corresponding metadata to terminate the conversation.",
"type": "string"
},
"supportedLanguageCodes": {
"description": "Optional. List of languages codes supported by the app, in addition to the `default_language_code`.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"LatencyReport": {
"description": "Latency report for the evaluation run.",
"id": "LatencyReport",
"properties": {
"callbackLatencies": {
"description": "Output only. Unordered list. Latency metrics for each callback.",
"items": {
"$ref": "LatencyReportCallbackLatency"
},
"readOnly": true,
"type": "array"
},
"guardrailLatencies": {
"description": "Output only. Unordered list. Latency metrics for each guardrail.",
"items": {
"$ref": "LatencyReportGuardrailLatency"
},
"readOnly": true,
"type": "array"
},
"llmCallLatencies": {
"description": "Output only. Unordered list. Latency metrics for each LLM call.",
"items": {
"$ref": "LatencyReportLlmCallLatency"
},
"readOnly": true,
"type": "array"
},
"sessionCount": {
"description": "Output only. The total number of sessions considered in the latency report.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"toolLatencies": {
"description": "Output only. Unordered list. Latency metrics for each tool.",
"items": {
"$ref": "LatencyReportToolLatency"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"LatencyReportCallbackLatency": {
"description": "Latency metrics for a single callback.",
"id": "LatencyReportCallbackLatency",
"properties": {
"latencyMetrics": {
"$ref": "LatencyReportLatencyMetrics",
"description": "Output only. The latency metrics for the callback.",
"readOnly": true
},
"stage": {
"description": "Output only. The stage of the callback.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"LatencyReportGuardrailLatency": {
"description": "Latency metrics for a single guardrail.",
"id": "LatencyReportGuardrailLatency",
"properties": {
"guardrail": {
"description": "Output only. The name of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`.",
"readOnly": true,
"type": "string"
},
"guardrailDisplayName": {
"description": "Output only. The display name of the guardrail.",
"readOnly": true,
"type": "string"
},
"latencyMetrics": {
"$ref": "LatencyReportLatencyMetrics",
"description": "Output only. The latency metrics for the guardrail.",
"readOnly": true
}
},
"type": "object"
},
"LatencyReportLatencyMetrics": {
"description": "Latency metrics for a component.",
"id": "LatencyReportLatencyMetrics",
"properties": {
"callCount": {
"description": "Output only. The number of times the resource was called.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"p50Latency": {
"description": "Output only. The 50th percentile latency.",
"format": "google-duration",
"readOnly": true,
"type": "string"
},
"p90Latency": {
"description": "Output only. The 90th percentile latency.",
"format": "google-duration",
"readOnly": true,
"type": "string"
},
"p99Latency": {
"description": "Output only. The 99th percentile latency.",
"format": "google-duration",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"LatencyReportLlmCallLatency": {
"description": "Latency metrics for a single LLM call.",
"id": "LatencyReportLlmCallLatency",
"properties": {
"latencyMetrics": {
"$ref": "LatencyReportLatencyMetrics",
"description": "Output only. The latency metrics for the LLM call.",
"readOnly": true
},
"model": {
"description": "Output only. The name of the model.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"LatencyReportToolLatency": {
"description": "Latency metrics for a single tool.",
"id": "LatencyReportToolLatency",
"properties": {
"latencyMetrics": {
"$ref": "LatencyReportLatencyMetrics",
"description": "Output only. The latency metrics for the tool.",
"readOnly": true
},
"tool": {
"description": "Output only. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.",
"readOnly": true,
"type": "string"
},
"toolDisplayName": {
"description": "Output only. The display name of the tool.",
"readOnly": true,
"type": "string"
},
"toolsetTool": {
"$ref": "ToolsetTool",
"description": "Output only. The toolset tool identifier.",
"readOnly": true
}
},
"type": "object"
},
"ListAgentsResponse": {
"description": "Response message for AgentService.ListAgents.",
"id": "ListAgentsResponse",
"properties": {
"agents": {
"description": "The list of agents.",
"items": {
"$ref": "Agent"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListAgentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListAppVersionsResponse": {
"description": "Response message for AgentService.ListAppVersions.",
"id": "ListAppVersionsResponse",
"properties": {
"appVersions": {
"description": "The list of app versions.",
"items": {
"$ref": "AppVersion"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListAppVersionsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListAppsResponse": {
"description": "Response message for AgentService.ListApps.",
"id": "ListAppsResponse",
"properties": {
"apps": {
"description": "The list of apps.",
"items": {
"$ref": "App"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListAppsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.",
"type": "string"
},
"unreachable": {
"description": "Unordered list. Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListChangelogsResponse": {
"description": "Response message for AgentService.ListChangelogs.",
"id": "ListChangelogsResponse",
"properties": {
"changelogs": {
"description": "The list of changelogs.",
"items": {
"$ref": "Changelog"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListChangelogsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListConversationsResponse": {
"description": "Response message for AgentService.ListConversations.",
"id": "ListConversationsResponse",
"properties": {
"conversations": {
"description": "The list of conversations.",
"items": {
"$ref": "Conversation"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListConversationsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListDeploymentsResponse": {
"description": "Response message for AgentService.ListDeployments.",
"id": "ListDeploymentsResponse",
"properties": {
"deployments": {
"description": "The list of deployments.",
"items": {
"$ref": "Deployment"
},
"type": "array"
},
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListEvaluationDatasetsResponse": {
"description": "Response message for EvaluationService.ListEvaluationDatasets.",
"id": "ListEvaluationDatasetsResponse",
"properties": {
"evaluationDatasets": {
"description": "The list of evaluation datasets.",
"items": {
"$ref": "EvaluationDataset"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListEvaluationDatasetsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListEvaluationExpectationsResponse": {
"description": "Response message for EvaluationService.ListEvaluationExpectations.",
"id": "ListEvaluationExpectationsResponse",
"properties": {
"evaluationExpectations": {
"description": "The list of evaluation expectations.",
"items": {
"$ref": "EvaluationExpectation"
},
"type": "array"
},
"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"
}
},
"type": "object"
},
"ListEvaluationResultsResponse": {
"description": "Response message for EvaluationService.ListEvaluationResults.",
"id": "ListEvaluationResultsResponse",
"properties": {
"evaluationResults": {
"description": "The list of evaluation results.",
"items": {
"$ref": "EvaluationResult"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListEvaluationRunsResponse": {
"description": "Response message for EvaluationService.ListEvaluationRuns.",
"id": "ListEvaluationRunsResponse",
"properties": {
"evaluationRuns": {
"description": "The list of evaluation runs.",
"items": {
"$ref": "EvaluationRun"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListEvaluationRunsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListEvaluationsResponse": {
"description": "Response message for EvaluationService.ListEvaluations.",
"id": "ListEvaluationsResponse",
"properties": {
"evaluations": {
"description": "The list of evaluations.",
"items": {
"$ref": "Evaluation"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListExamplesResponse": {
"description": "Response message for AgentService.ListExamples.",
"id": "ListExamplesResponse",
"properties": {
"examples": {
"description": "The list of examples.",
"items": {
"$ref": "Example"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListExamplesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListGuardrailsResponse": {
"description": "Response message for AgentService.ListGuardrails.",
"id": "ListGuardrailsResponse",
"properties": {
"guardrails": {
"description": "The list of guardrails.",
"items": {
"$ref": "Guardrail"
},
"type": "array"
},
"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"
}
},
"type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
},
"unreachable": {
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListScheduledEvaluationRunsResponse": {
"description": "Response message for EvaluationService.ListScheduledEvaluationRuns.",
"id": "ListScheduledEvaluationRunsResponse",
"properties": {
"nextPageToken": {
"description": "A token that can be sent as ListScheduledEvaluationRunsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.",
"type": "string"
},
"scheduledEvaluationRuns": {
"description": "The list of scheduled evaluation runs.",
"items": {
"$ref": "ScheduledEvaluationRun"
},
"type": "array"
}
},
"type": "object"
},
"ListToolsResponse": {
"description": "Response message for AgentService.ListTools.",
"id": "ListToolsResponse",
"properties": {
"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"
},
"tools": {
"description": "The list of tools.",
"items": {
"$ref": "Tool"
},
"type": "array"
}
},
"type": "object"
},
"ListToolsetsResponse": {
"description": "Response message for AgentService.ListToolsets.",
"id": "ListToolsetsResponse",
"properties": {
"nextPageToken": {
"description": "A token that can be sent as ListToolsetsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.",
"type": "string"
},
"toolsets": {
"description": "The list of toolsets.",
"items": {
"$ref": "Toolset"
},
"type": "array"
}
},
"type": "object"
},
"Location": {
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"type": "object"
},
"LoggingSettings": {
"description": "Settings to describe the logging behaviors for the app.",
"id": "LoggingSettings",
"properties": {
"audioRecordingConfig": {
"$ref": "AudioRecordingConfig",
"description": "Optional. Configuration for how audio interactions should be recorded."
},
"bigqueryExportSettings": {
"$ref": "BigQueryExportSettings",
"description": "Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled."
},
"cloudLoggingSettings": {
"$ref": "CloudLoggingSettings",
"description": "Optional. Settings to describe the Cloud Logging behaviors for the app."
},
"conversationLoggingSettings": {
"$ref": "ConversationLoggingSettings",
"description": "Optional. Settings to describe the conversation logging behaviors for the app."
},
"evaluationAudioRecordingConfig": {
"$ref": "AudioRecordingConfig",
"description": "Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions."
},
"metricAnalysisSettings": {
"$ref": "MetricAnalysisSettings",
"description": "Optional. Settings to describe the conversation data collection behaviors for the LLM analysis pipeline for the app."
},
"redactionConfig": {
"$ref": "RedactionConfig",
"description": "Optional. Configuration for how sensitive data should be redacted."
},
"unredactedAudioRecordingConfig": {
"$ref": "AudioRecordingConfig",
"description": "Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes."
}
},
"type": "object"
},
"McpTool": {
"description": "An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details.",
"id": "McpTool",
"properties": {
"apiAuthentication": {
"$ref": "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."
},
"customHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.",
"type": "object"
},
"description": {
"description": "Optional. The description of the MCP tool.",
"type": "string"
},
"inputSchema": {
"$ref": "Schema",
"description": "Optional. The schema of the input arguments of the MCP tool."
},
"name": {
"description": "Required. The name of the MCP tool.",
"type": "string"
},
"outputSchema": {
"$ref": "Schema",
"description": "Optional. The schema of the output arguments of the MCP tool."
},
"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": {
"$ref": "TlsConfig",
"description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust."
}
},
"type": "object"
},
"McpToolset": {
"description": "A toolset that contains a list of tools that are offered by the MCP server.",
"id": "McpToolset",
"properties": {
"apiAuthentication": {
"$ref": "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."
},
"customHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.",
"type": "object"
},
"serverAddress": {
"description": "Required. The address of the MCP server, for example, \"https://example.com/mcp/\". If the server is built with the MCP SDK, the url should be suffixed with \"/mcp/\". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.",
"type": "string"
},
"serviceDirectoryConfig": {
"$ref": "ServiceDirectoryConfig",
"description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter."
},
"tlsConfig": {
"$ref": "TlsConfig",
"description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust."
}
},
"type": "object"
},
"Message": {
"description": "A message within a conversation.",
"id": "Message",
"properties": {
"chunks": {
"description": "Optional. Content of the message as a series of chunks.",
"items": {
"$ref": "Chunk"
},
"type": "array"
},
"eventTime": {
"description": "Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.",
"format": "google-datetime",
"type": "string"
},
"role": {
"description": "Optional. The role within the conversation, e.g., user, agent.",
"type": "string"
}
},
"type": "object"
},
"MetricAnalysisSettings": {
"description": "Settings to describe the conversation data collection behaviors for LLM analysis metrics pipeline.",
"id": "MetricAnalysisSettings",
"properties": {
"llmMetricsOptedOut": {
"description": "Optional. Whether to collect conversation data for llm analysis metrics. If true, conversation data will not be collected for llm analysis metrics; otherwise, conversation data will be collected.",
"type": "boolean"
}
},
"type": "object"
},
"MockConfig": {
"description": "Mock tool calls configuration for the session.",
"id": "MockConfig",
"properties": {
"mockedToolCalls": {
"description": "Optional. All tool calls to mock for the duration of the session.",
"items": {
"$ref": "MockedToolCall"
},
"type": "array"
},
"unmatchedToolCallBehavior": {
"description": "Required. Beavhior for tool calls that don't match any args patterns in mocked_tool_calls.",
"enum": [
"UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED",
"FAIL",
"PASS_THROUGH"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Throw an error for any tool calls that don't match a mock expected input pattern.",
"For unmatched tool calls, pass the tool call through to real tool."
],
"type": "string"
}
},
"type": "object"
},
"MockedToolCall": {
"description": "A mocked tool call. Expresses the target tool + a pattern to match against that tool's args / inputs. If the pattern matches, then the mock response will be returned.",
"id": "MockedToolCall",
"properties": {
"expectedArgsPattern": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Required. A pattern to match against the args / inputs of all dispatched tool calls. If the tool call inputs match this pattern, then mock output will be returned.",
"type": "object"
},
"mockResponse": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The mock response / output to return if the tool call args / inputs match the pattern.",
"type": "object"
},
"tool": {
"deprecated": true,
"description": "Optional. Deprecated. Use tool_identifier instead.",
"type": "string"
},
"toolId": {
"description": "Optional. The name of the tool to mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`",
"type": "string"
},
"toolset": {
"$ref": "ToolsetTool",
"description": "Optional. The toolset to mock."
}
},
"type": "object"
},
"ModelSettings": {
"description": "Model settings contains various configurations for the LLM model.",
"id": "ModelSettings",
"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.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"OAuthConfig": {
"description": "Configurations for authentication with OAuth.",
"id": "OAuthConfig",
"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"
},
"oauthGrantType": {
"description": "Required. OAuth grant types.",
"enum": [
"OAUTH_GRANT_TYPE_UNSPECIFIED",
"CLIENT_CREDENTIAL"
],
"enumDescriptions": [
"Unspecified. Defaults to CLIENT_CREDENTIAL.",
"Represents the [client credential flow](https://oauth.net/2/grant-types/client-credentials)."
],
"type": "string"
},
"scopes": {
"description": "Optional. The OAuth scopes to grant.",
"items": {
"type": "string"
},
"type": "array"
},
"tokenEndpoint": {
"description": "Required. The token endpoint in the OAuth provider to exchange for an access token.",
"type": "string"
}
},
"type": "object"
},
"Omnichannel": {
"description": "Represents an Omnichannel resource.",
"id": "Omnichannel",
"properties": {
"createTime": {
"description": "Output only. Timestamp when the omnichannel resource was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Human-readable description of the omnichannel resource.",
"type": "string"
},
"displayName": {
"description": "Required. Display name of the omnichannel resource.",
"type": "string"
},
"etag": {
"description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation.",
"readOnly": true,
"type": "string"
},
"integrationConfig": {
"$ref": "OmnichannelIntegrationConfig",
"description": "Optional. The integration config for the omnichannel resource."
},
"name": {
"description": "Identifier. The unique identifier of the omnichannel resource. Format: `projects/{project}/locations/{location}/omnichannels/{omnichannel}`",
"type": "string"
},
"updateTime": {
"description": "Output only. Timestamp when the omnichannel resource was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"OmnichannelIntegrationConfig": {
"description": "OmnichannelIntegrationConfig contains all App integration configs.",
"id": "OmnichannelIntegrationConfig",
"properties": {
"channelConfigs": {
"additionalProperties": {
"$ref": "OmnichannelIntegrationConfigChannelConfig"
},
"description": "Optional. Various of configuration for handling App events.",
"type": "object"
},
"routingConfigs": {
"additionalProperties": {
"$ref": "OmnichannelIntegrationConfigRoutingConfig"
},
"description": "Optional. The key of routing_configs is a key of `app_configs`, value is a `RoutingConfig`, which contains subscriber's key.",
"type": "object"
},
"subscriberConfigs": {
"additionalProperties": {
"$ref": "OmnichannelIntegrationConfigSubscriberConfig"
},
"description": "Optional. Various of subscribers configs.",
"type": "object"
}
},
"type": "object"
},
"OmnichannelIntegrationConfigCesAppConfig": {
"description": "Configs for CES app.",
"id": "OmnichannelIntegrationConfigCesAppConfig",
"properties": {
"app": {
"description": "The unique identifier of the CES app. Format: `projects/{project}/locations/{location}/apps/{app}`",
"type": "string"
}
},
"type": "object"
},
"OmnichannelIntegrationConfigChannelConfig": {
"description": "ChannelConfig contains config for various of app integration.",
"id": "OmnichannelIntegrationConfigChannelConfig",
"properties": {
"whatsappConfig": {
"$ref": "OmnichannelIntegrationConfigWhatsappConfig",
"description": "WhatsApp config."
}
},
"type": "object"
},
"OmnichannelIntegrationConfigRoutingConfig": {
"description": "Routing config specify how/who to route app events to a subscriber.",
"id": "OmnichannelIntegrationConfigRoutingConfig",
"properties": {
"subscriberKey": {
"description": "The key of the subscriber.",
"type": "string"
}
},
"type": "object"
},
"OmnichannelIntegrationConfigSubscriberConfig": {
"description": "Configs of subscribers.",
"id": "OmnichannelIntegrationConfigSubscriberConfig",
"properties": {
"cesAppConfig": {
"$ref": "OmnichannelIntegrationConfigCesAppConfig",
"description": "Ces app config."
}
},
"type": "object"
},
"OmnichannelIntegrationConfigWhatsappConfig": {
"description": "How Omnichannel should receive/reply events from WhatsApp.",
"id": "OmnichannelIntegrationConfigWhatsappConfig",
"properties": {
"metaBusinessPortfolioId": {
"description": "The Meta Business Portfolio (MBP) ID. https://www.facebook.com/business/help/1710077379203657",
"type": "string"
},
"phoneNumber": {
"description": "The phone number used for sending/receiving messages.",
"type": "string"
},
"phoneNumberId": {
"description": "The Phone Number ID associated with the WhatsApp Business Account.",
"type": "string"
},
"webhookVerifyToken": {
"description": "The verify token configured in the Meta App Dashboard for webhook verification.",
"type": "string"
},
"whatsappBusinessAccountId": {
"description": "The customer's WhatsApp Business Account (WABA) ID.",
"type": "string"
},
"whatsappBusinessToken": {
"description": "The access token for authenticating API calls to the WhatsApp Cloud API. https://developers.facebook.com/docs/whatsapp/business-management-api/get-started/#business-integration-system-user-access-tokens",
"type": "string"
}
},
"type": "object"
},
"OmnichannelOperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "OmnichannelOperationMetadata",
"properties": {
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"OpenApiTool": {
"description": "A remote API tool defined by an OpenAPI schema.",
"id": "OpenApiTool",
"properties": {
"apiAuthentication": {
"$ref": "ApiAuthentication",
"description": "Optional. Authentication information required by the API."
},
"description": {
"description": "Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.",
"type": "string"
},
"ignoreUnknownFields": {
"description": "Optional. If true, the agent will ignore unknown fields in the API response.",
"type": "boolean"
},
"name": {
"description": "Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.",
"type": "string"
},
"openApiSchema": {
"description": "Required. The OpenAPI schema in JSON or YAML format.",
"type": "string"
},
"serviceDirectoryConfig": {
"$ref": "ServiceDirectoryConfig",
"description": "Optional. Service Directory configuration."
},
"tlsConfig": {
"$ref": "TlsConfig",
"description": "Optional. The TLS configuration. Includes the custom server certificates that the client will trust."
},
"url": {
"description": "Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.",
"type": "string"
}
},
"type": "object"
},
"OpenApiToolset": {
"description": "A toolset that contains a list of tools that are defined by an OpenAPI schema.",
"id": "OpenApiToolset",
"properties": {
"apiAuthentication": {
"$ref": "ApiAuthentication",
"description": "Optional. Authentication information required by the API."
},
"ignoreUnknownFields": {
"description": "Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.",
"type": "boolean"
},
"openApiSchema": {
"description": "Required. The OpenAPI schema of the toolset.",
"type": "string"
},
"serviceDirectoryConfig": {
"$ref": "ServiceDirectoryConfig",
"description": "Optional. Service Directory configuration."
},
"tlsConfig": {
"$ref": "TlsConfig",
"description": "Optional. The TLS configuration. Includes the custom server certificates"
},
"url": {
"description": "Optional. The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.",
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "OperationMetadata",
"properties": {
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"OptimizationConfig": {
"description": "Configuration for running the optimization step after the evaluation run.",
"id": "OptimizationConfig",
"properties": {
"assistantSession": {
"description": "Output only. The assistant session to use for the optimization based on this evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}`",
"readOnly": true,
"type": "string"
},
"errorMessage": {
"description": "Output only. The error message if the optimization run failed.",
"readOnly": true,
"type": "string"
},
"generateLossReport": {
"description": "Optional. Whether to generate a loss report.",
"type": "boolean"
},
"lossReport": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Output only. The generated loss report.",
"readOnly": true,
"type": "object"
},
"reportSummary": {
"description": "Output only. The summary of the loss report.",
"readOnly": true,
"type": "string"
},
"shouldSuggestFix": {
"description": "Output only. Whether to suggest a fix for the losses.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Output only. The status of the optimization run.",
"enum": [
"OPTIMIZATION_STATUS_UNSPECIFIED",
"RUNNING",
"COMPLETED",
"ERROR"
],
"enumDescriptions": [
"Optimization status is not specified.",
"Optimization is running.",
"Optimization has completed.",
"Optimization failed due to an internal error."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"OutputAudioConfig": {
"description": "OutputAudioConfig configures how the CES agent should synthesize outgoing audio responses.",
"id": "OutputAudioConfig",
"properties": {
"audioEncoding": {
"description": "Required. The encoding of the output audio data.",
"enum": [
"AUDIO_ENCODING_UNSPECIFIED",
"LINEAR16",
"MULAW",
"ALAW"
],
"enumDescriptions": [
"Unspecified audio encoding.",
"16-bit linear PCM audio encoding.",
"8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
"8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law."
],
"type": "string"
},
"sampleRateHertz": {
"description": "Required. The sample rate (in Hertz) of the output audio data.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"PersonaRunConfig": {
"description": "Configuration for running an evaluation for a specific persona.",
"id": "PersonaRunConfig",
"properties": {
"persona": {
"description": "Optional. The persona to use for the evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`",
"type": "string"
},
"taskCount": {
"description": "Optional. The number of tasks to run for the persona.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"PythonCodeCondition": {
"description": "Python code block to evaluate the condition.",
"id": "PythonCodeCondition",
"properties": {
"pythonCode": {
"description": "Required. The python code to execute.",
"type": "string"
}
},
"type": "object"
},
"PythonFunction": {
"description": "A Python function tool.",
"id": "PythonFunction",
"properties": {
"description": {
"description": "Output only. The description of the Python function, parsed from the python code's docstring.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.",
"type": "string"
},
"pythonCode": {
"description": "Optional. The Python code to execute for the tool.",
"type": "string"
}
},
"type": "object"
},
"QualityReport": {
"description": "The report describing any identified quality issues in the app.",
"id": "QualityReport",
"properties": {
"evaluationRuns": {
"description": "Optional. A list of evaluation runs used to generate the quality report. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluationRun}`.",
"items": {
"type": "string"
},
"type": "array"
},
"generalIssues": {
"description": "Optional. General issues not specific to any agent.",
"items": {
"$ref": "QualityReportIssue"
},
"type": "array"
},
"issues": {
"description": "Optional. The issues grouped by agent.",
"items": {
"$ref": "QualityReportAgentIssues"
},
"type": "array"
}
},
"type": "object"
},
"QualityReportAgentIssues": {
"description": "Issues identified for a single agent.",
"id": "QualityReportAgentIssues",
"properties": {
"agent": {
"description": "Optional. The name of the agent to which the issues are related. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
"type": "string"
},
"issues": {
"description": "Optional. List of issues found for this agent.",
"items": {
"$ref": "QualityReportIssue"
},
"type": "array"
}
},
"type": "object"
},
"QualityReportIssue": {
"description": "The issue identified.",
"id": "QualityReportIssue",
"properties": {
"description": {
"description": "Optional. Description of the issue found.",
"type": "string"
},
"occurrenceCount": {
"description": "Optional. How many times this issue occurred.",
"format": "int32",
"type": "integer"
},
"proposedSolution": {
"description": "Optional. Proposed solution to fix the issue by modifying instructions or tools.",
"type": "string"
}
},
"type": "object"
},
"RedactionConfig": {
"description": "Configuration to instruct how sensitive data should be handled.",
"id": "RedactionConfig",
"properties": {
"deidentifyTemplate": {
"description": "Optional. [DLP](https://cloud.google.com/dlp/docs) deidentify template name to instruct on how to de-identify content. Format: `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}`",
"type": "string"
},
"enableRedaction": {
"description": "Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.",
"type": "boolean"
},
"inspectTemplate": {
"description": "Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}`",
"type": "string"
}
},
"type": "object"
},
"RestoreAppVersionRequest": {
"description": "Request message for AgentService.RestoreAppVersion",
"id": "RestoreAppVersionRequest",
"properties": {},
"type": "object"
},
"RetrieveToolSchemaRequest": {
"description": "Request message for ToolService.RetrieveToolSchema.",
"id": "RetrieveToolSchemaRequest",
"properties": {
"tool": {
"description": "Optional. The name of the tool to retrieve the schema for. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}",
"type": "string"
},
"toolsetTool": {
"$ref": "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."
}
},
"type": "object"
},
"RetrieveToolSchemaResponse": {
"description": "Response message for ToolService.RetrieveToolSchema.",
"id": "RetrieveToolSchemaResponse",
"properties": {
"inputSchema": {
"$ref": "Schema",
"description": "The schema of the tool input parameters."
},
"outputSchema": {
"$ref": "Schema",
"description": "The schema of the tool output parameters."
},
"tool": {
"description": "The name of the tool that the schema is for. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`",
"type": "string"
},
"toolsetTool": {
"$ref": "ToolsetTool",
"description": "The toolset tool that the schema is for."
}
},
"type": "object"
},
"RetrieveToolsRequest": {
"description": "Request message for ToolService.RetrieveTools.",
"id": "RetrieveToolsRequest",
"properties": {
"toolIds": {
"description": "Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RetrieveToolsResponse": {
"description": "Response message for ToolService.RetrieveTools.",
"id": "RetrieveToolsResponse",
"properties": {
"tools": {
"description": "The list of tools that are included in the specified toolset.",
"items": {
"$ref": "Tool"
},
"type": "array"
}
},
"type": "object"
},
"RunEvaluationRequest": {
"description": "Request message for EvaluationService.RunEvaluation.",
"id": "RunEvaluationRequest",
"properties": {
"app": {
"description": "Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}`",
"type": "string"
},
"appVersion": {
"description": "Optional. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`",
"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"
},
"evaluationDataset": {
"description": "Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`",
"type": "string"
},
"evaluations": {
"description": "Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`",
"items": {
"type": "string"
},
"type": "array"
},
"generateLatencyReport": {
"description": "Optional. Whether to generate a latency report for the evaluation run.",
"type": "boolean"
},
"goldenRunMethod": {
"description": "Optional. The method to run the evaluation if it is a golden evaluation. If not set, default to STABLE.",
"enum": [
"GOLDEN_RUN_METHOD_UNSPECIFIED",
"STABLE",
"NAIVE"
],
"enumDescriptions": [
"Run method is not specified.",
"Run the evaluation as stable replay, where each turn is a unique session with the previous expected turns injected as context.",
"Run the evaluation as naive replay, where the run is a single session with no context injected."
],
"type": "string"
},
"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."
},
"personaRunConfigs": {
"description": "Optional. The configuration to use for the run per persona.",
"items": {
"$ref": "PersonaRunConfig"
},
"type": "array"
},
"runCount": {
"description": "Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario.",
"format": "int32",
"type": "integer"
},
"scheduledEvaluationRun": {
"description": "Optional. The resource name of the `ScheduledEvaluationRun` that is triggering this evaluation run. If this field is set, the `scheduled_evaluation_run` field on the created `EvaluationRun` resource will be populated from this value. Format: `projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}`",
"type": "string"
}
},
"type": "object"
},
"RunSessionRequest": {
"description": "Request message for SessionService.RunSession.",
"id": "RunSessionRequest",
"properties": {
"config": {
"$ref": "SessionConfig",
"description": "Required. The configuration for the session."
},
"inputs": {
"description": "Required. Inputs for the session.",
"items": {
"$ref": "SessionInput"
},
"type": "array"
}
},
"type": "object"
},
"RunSessionResponse": {
"description": "Response message for SessionService.RunSession.",
"id": "RunSessionResponse",
"properties": {
"outputs": {
"description": "Outputs for the session.",
"items": {
"$ref": "SessionOutput"
},
"type": "array"
}
},
"type": "object"
},
"ScheduledEvaluationRun": {
"description": "Represents a scheduled evaluation run configuration.",
"id": "ScheduledEvaluationRun",
"properties": {
"active": {
"description": "Optional. Whether this config is active",
"type": "boolean"
},
"createTime": {
"description": "Output only. Timestamp when the scheduled evaluation run was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"createdBy": {
"description": "Output only. The user who created the scheduled evaluation run.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. User-defined description of the scheduled evaluation run.",
"type": "string"
},
"displayName": {
"description": "Required. User-defined display name of the scheduled evaluation run config.",
"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"
},
"lastCompletedRun": {
"description": "Output only. The last successful EvaluationRun of this scheduled execution. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`",
"readOnly": true,
"type": "string"
},
"lastUpdatedBy": {
"description": "Output only. The user who last updated the evaluation.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}",
"type": "string"
},
"nextScheduledExecutionTime": {
"description": "Output only. The next time this is scheduled to execute",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"request": {
"$ref": "RunEvaluationRequest",
"description": "Required. The RunEvaluationRequest to schedule"
},
"schedulingConfig": {
"$ref": "ScheduledEvaluationRunSchedulingConfig",
"description": "Required. Configuration for the timing and frequency with which to execute the evaluations."
},
"totalExecutions": {
"description": "Output only. The total number of times this run has been executed",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"updateTime": {
"description": "Output only. Timestamp when the evaluation was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ScheduledEvaluationRunSchedulingConfig": {
"description": "Eval scheduling configuration details",
"id": "ScheduledEvaluationRunSchedulingConfig",
"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.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"frequency": {
"description": "Required. The frequency with which to run the eval",
"enum": [
"FREQUENCY_UNSPECIFIED",
"NONE",
"DAILY",
"WEEKLY",
"BIWEEKLY"
],
"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."
],
"type": "string"
},
"startTime": {
"description": "Required. Timestamp when the eval should start.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Schema": {
"description": "Represents a select subset of an OpenAPI 3.0 schema object.",
"id": "Schema",
"properties": {
"additionalProperties": {
"$ref": "Schema",
"description": "Optional. Can either be a boolean or an object, controls the presence of additional properties."
},
"anyOf": {
"description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.",
"items": {
"$ref": "Schema"
},
"type": "array"
},
"default": {
"description": "Optional. Default value of the data.",
"type": "any"
},
"defs": {
"additionalProperties": {
"$ref": "Schema"
},
"description": "Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.",
"type": "object"
},
"description": {
"description": "Optional. The description of the data.",
"type": "string"
},
"enum": {
"description": "Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}",
"items": {
"type": "string"
},
"type": "array"
},
"items": {
"$ref": "Schema",
"description": "Optional. Schema of the elements of Type.ARRAY."
},
"maxItems": {
"description": "Optional. Maximum number of the elements for Type.ARRAY.",
"format": "int64",
"type": "string"
},
"maximum": {
"description": "Optional. Maximum value for Type.INTEGER and Type.NUMBER.",
"format": "double",
"type": "number"
},
"minItems": {
"description": "Optional. Minimum number of the elements for Type.ARRAY.",
"format": "int64",
"type": "string"
},
"minimum": {
"description": "Optional. Minimum value for Type.INTEGER and Type.NUMBER.",
"format": "double",
"type": "number"
},
"nullable": {
"description": "Optional. Indicates if the value may be null.",
"type": "boolean"
},
"prefixItems": {
"description": "Optional. Schemas of initial elements of Type.ARRAY.",
"items": {
"$ref": "Schema"
},
"type": "array"
},
"properties": {
"additionalProperties": {
"$ref": "Schema"
},
"description": "Optional. Properties of Type.OBJECT.",
"type": "object"
},
"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"
},
"required": {
"description": "Optional. Required properties of Type.OBJECT.",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "Optional. The title of the schema.",
"type": "string"
},
"type": {
"description": "Required. The type of the data.",
"enum": [
"TYPE_UNSPECIFIED",
"STRING",
"INTEGER",
"NUMBER",
"BOOLEAN",
"OBJECT",
"ARRAY"
],
"enumDescriptions": [
"Type unspecified.",
"String type.",
"Integer type.",
"Number type.",
"Boolean type.",
"Object type.",
"Array type."
],
"type": "string"
},
"uniqueItems": {
"description": "Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.",
"type": "boolean"
}
},
"type": "object"
},
"SecuritySettings": {
"description": "Project/Location level security settings for CES.",
"id": "SecuritySettings",
"properties": {
"createTime": {
"description": "Output only. Create time of the security settings.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endpointControlPolicy": {
"$ref": "EndpointControlPolicy",
"description": "Optional. Endpoint control related settings."
},
"etag": {
"description": "Output only. Etag of the security settings.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`",
"type": "string"
},
"updateTime": {
"description": "Output only. Last update time of the security settings.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ServiceAccountAuthConfig": {
"description": "Configurations for authentication using a custom service account.",
"id": "ServiceAccountAuthConfig",
"properties": {
"scopes": {
"description": "Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.",
"items": {
"type": "string"
},
"type": "array"
},
"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"
}
},
"type": "object"
},
"ServiceAgentIdTokenAuthConfig": {
"description": "Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent.",
"id": "ServiceAgentIdTokenAuthConfig",
"properties": {},
"type": "object"
},
"ServiceDirectoryConfig": {
"description": "Configuration for tools using Service Directory.",
"id": "ServiceDirectoryConfig",
"properties": {
"service": {
"description": "Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.",
"type": "string"
}
},
"type": "object"
},
"SessionConfig": {
"description": "The configuration for the session.",
"id": "SessionConfig",
"properties": {
"deployment": {
"description": "Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`",
"type": "string"
},
"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"
},
"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": {
"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.",
"items": {
"$ref": "Message"
},
"type": "array"
},
"inputAudioConfig": {
"$ref": "InputAudioConfig",
"description": "Optional. Configuration for processing the input audio."
},
"outputAudioConfig": {
"$ref": "OutputAudioConfig",
"description": "Optional. Configuration for generating the output audio."
},
"remoteDialogflowQueryParameters": {
"$ref": "SessionConfigRemoteDialogflowQueryParameters",
"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."
},
"timeZone": {
"description": "Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. \"America/Los_Angeles\".",
"type": "string"
},
"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"
}
},
"type": "object"
},
"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",
"properties": {
"endUserMetadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The end user metadata to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).",
"type": "object"
},
"payload": {
"additionalProperties": {
"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).",
"type": "object"
},
"webhookHeaders": {
"additionalProperties": {
"type": "string"
},
"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"
}
},
"type": "object"
},
"SessionInput": {
"description": "Input for the session.",
"id": "SessionInput",
"properties": {
"audio": {
"description": "Optional. Audio data from the end user.",
"format": "byte",
"type": "string"
},
"blob": {
"$ref": "Blob",
"description": "Optional. Blob data from the end user."
},
"dtmf": {
"description": "Optional. DTMF digits from the end user.",
"type": "string"
},
"event": {
"$ref": "Event",
"description": "Optional. Event input."
},
"image": {
"$ref": "Image",
"description": "Optional. Image data from the end user."
},
"text": {
"description": "Optional. Text data from the end user.",
"type": "string"
},
"toolResponses": {
"$ref": "ToolResponses",
"description": "Optional. Execution results for the tool calls from the client."
},
"variables": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.",
"type": "object"
},
"willContinue": {
"description": "Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.",
"type": "boolean"
}
},
"type": "object"
},
"SessionOutput": {
"description": "Output for the session.",
"id": "SessionOutput",
"properties": {
"audio": {
"description": "Output audio from the CES agent.",
"format": "byte",
"type": "string"
},
"citations": {
"$ref": "Citations",
"description": "Citations that provide the source information for the agent's generated text."
},
"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."
},
"endSession": {
"$ref": "EndSession",
"description": "Indicates the session has ended."
},
"googleSearchSuggestions": {
"$ref": "GoogleSearchSuggestions",
"description": "The suggestions returned from Google Search as a result of invoking the GoogleSearchTool."
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Custom payload with structured output from the CES agent.",
"type": "object"
},
"text": {
"description": "Output text from the CES agent.",
"type": "string"
},
"toolCalls": {
"$ref": "ToolCalls",
"description": "Request for the client to execute the tools."
},
"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"
},
"turnIndex": {
"description": "Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"SessionOutputDiagnosticInfo": {
"description": "Contains execution details during the processing.",
"id": "SessionOutputDiagnosticInfo",
"properties": {
"messages": {
"description": "List of the messages that happened during the processing.",
"items": {
"$ref": "Message"
},
"type": "array"
},
"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."
}
},
"type": "object"
},
"Span": {
"description": "A span is a unit of work or a single operation during the request processing.",
"id": "Span",
"properties": {
"attributes": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Output only. Key-value attributes associated with the span.",
"readOnly": true,
"type": "object"
},
"childSpans": {
"description": "Output only. The child spans that are nested under this span.",
"items": {
"$ref": "Span"
},
"readOnly": true,
"type": "array"
},
"duration": {
"description": "Output only. The duration of the span.",
"format": "google-duration",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The end time of the span.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The name of the span.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Output only. The start time of the span.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"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"
}
},
"type": "object"
},
"SynthesizeSpeechConfig": {
"description": "Configuration for how the agent response should be synthesized.",
"id": "SynthesizeSpeechConfig",
"properties": {
"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"
},
"voice": {
"description": "Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud Text-to-Speech.",
"type": "string"
}
},
"type": "object"
},
"SystemTool": {
"description": "Pre-defined system tool.",
"id": "SystemTool",
"properties": {
"description": {
"description": "Output only. The description of the system tool.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Required. The name of the system tool.",
"type": "string"
}
},
"type": "object"
},
"TestPersonaVoiceRequest": {
"description": "Request message for EvaluationService.TestPersonaVoice.",
"id": "TestPersonaVoiceRequest",
"properties": {
"personaId": {
"description": "Required. The persona ID to test the voice for. Also accepts \"default\".",
"type": "string"
},
"text": {
"description": "Required. The text to test the voice for.",
"type": "string"
}
},
"type": "object"
},
"TestPersonaVoiceResponse": {
"description": "Response message for EvaluationService.TestPersonaVoice.",
"id": "TestPersonaVoiceResponse",
"properties": {
"audio": {
"description": "The audio data bytes of the synthesized voice.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"TimeZoneSettings": {
"description": "TimeZone settings of the app.",
"id": "TimeZoneSettings",
"properties": {
"timeZone": {
"description": "Optional. The time zone of the app from the [time zone database](https://www.iana.org/time-zones), e.g., America/Los_Angeles, Europe/Paris.",
"type": "string"
}
},
"type": "object"
},
"TlsConfig": {
"description": "The TLS configuration.",
"id": "TlsConfig",
"properties": {
"caCerts": {
"description": "Required. Specifies a list of allowed custom CA certificates for HTTPS verification.",
"items": {
"$ref": "TlsConfigCaCert"
},
"type": "array"
}
},
"type": "object"
},
"TlsConfigCaCert": {
"description": "The CA certificate.",
"id": "TlsConfigCaCert",
"properties": {
"cert": {
"description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```",
"format": "byte",
"type": "string"
},
"displayName": {
"description": "Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.",
"type": "string"
}
},
"type": "object"
},
"Tool": {
"description": "A tool represents an action that the CES agent can take to achieve certain goals.",
"id": "Tool",
"properties": {
"agentTool": {
"$ref": "AgentTool",
"description": "Optional. The agent tool."
},
"clientFunction": {
"$ref": "ClientFunction",
"description": "Optional. The client function."
},
"connectorTool": {
"$ref": "ConnectorTool",
"description": "Optional. The Integration Connector tool."
},
"createTime": {
"description": "Output only. Timestamp when the tool was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataStoreTool": {
"$ref": "DataStoreTool",
"description": "Optional. The data store tool."
},
"displayName": {
"description": "Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its `name` property.",
"readOnly": true,
"type": "string"
},
"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"
},
"executionType": {
"description": "Optional. The execution type of the tool.",
"enum": [
"EXECUTION_TYPE_UNSPECIFIED",
"SYNCHRONOUS",
"ASYNCHRONOUS"
],
"enumDescriptions": [
"The execution type is unspecified. Defaults to `SYNCHRONOUS` if unspecified.",
"The tool is executed synchronously. The session is blocked until the tool returns.",
"The tool is executed asynchronously. The session will continue while the tool is executing."
],
"type": "string"
},
"fileSearchTool": {
"$ref": "FileSearchTool",
"description": "Optional. The file search tool."
},
"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"
},
"googleSearchTool": {
"$ref": "GoogleSearchTool",
"description": "Optional. The google search tool."
},
"mcpTool": {
"$ref": "McpTool",
"description": "Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset."
},
"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"
},
"openApiTool": {
"$ref": "OpenApiTool",
"description": "Optional. The open API tool."
},
"pythonFunction": {
"$ref": "PythonFunction",
"description": "Optional. The python function tool."
},
"systemTool": {
"$ref": "SystemTool",
"description": "Optional. The system tool."
},
"toolFakeConfig": {
"$ref": "ToolFakeConfig",
"description": "Optional. Configuration for tool behavior in fake mode."
},
"updateTime": {
"description": "Output only. Timestamp when the tool was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"widgetTool": {
"$ref": "WidgetTool",
"description": "Optional. The widget tool."
}
},
"type": "object"
},
"ToolCall": {
"description": "Request for the client or the agent to execute the specified tool.",
"id": "ToolCall",
"properties": {
"args": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. The input parameters and values for the tool in JSON object format.",
"type": "object"
},
"displayName": {
"description": "Output only. Display name of the tool.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.",
"type": "string"
},
"tool": {
"description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`",
"type": "string"
},
"toolsetTool": {
"$ref": "ToolsetTool",
"description": "Optional. The toolset tool to execute."
}
},
"type": "object"
},
"ToolCalls": {
"description": "Request for the client to execute the tools and return the execution results before continuing the session.",
"id": "ToolCalls",
"properties": {
"toolCalls": {
"description": "Optional. The list of tool calls to execute.",
"items": {
"$ref": "ToolCall"
},
"type": "array"
}
},
"type": "object"
},
"ToolFakeConfig": {
"description": "Configuration for tool behavior in fake mode.",
"id": "ToolFakeConfig",
"properties": {
"codeBlock": {
"$ref": "CodeBlock",
"description": "Optional. Code block which will be executed instead of a real tool call."
},
"enableFakeMode": {
"description": "Optional. Whether the tool is using fake mode.",
"type": "boolean"
}
},
"type": "object"
},
"ToolResponse": {
"description": "The execution result of a specific tool from the client or the agent.",
"id": "ToolResponse",
"properties": {
"displayName": {
"description": "Output only. Display name of the tool.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Optional. The matching ID of the tool call the response is for.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Required. The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result.",
"type": "object"
},
"tool": {
"description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`",
"type": "string"
},
"toolsetTool": {
"$ref": "ToolsetTool",
"description": "Optional. The toolset tool that got executed."
}
},
"type": "object"
},
"ToolResponses": {
"description": "Execution results for the requested tool calls from the client.",
"id": "ToolResponses",
"properties": {
"toolResponses": {
"description": "Optional. The list of tool execution results.",
"items": {
"$ref": "ToolResponse"
},
"type": "array"
}
},
"type": "object"
},
"Toolset": {
"description": "A toolset represents a group of dynamically managed tools that can be used by the agent.",
"id": "Toolset",
"properties": {
"connectorToolset": {
"$ref": "ConnectorToolset",
"description": "Optional. A toolset that generates tools from an Integration Connectors Connection."
},
"createTime": {
"description": "Output only. Timestamp when the toolset was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. The description of the toolset.",
"type": "string"
},
"displayName": {
"description": "Optional. The display name of the toolset. Must be unique within the same app.",
"type": "string"
},
"etag": {
"description": "ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.",
"type": "string"
},
"executionType": {
"description": "Optional. The execution type of the tools in the toolset.",
"enum": [
"EXECUTION_TYPE_UNSPECIFIED",
"SYNCHRONOUS",
"ASYNCHRONOUS"
],
"enumDescriptions": [
"The execution type is unspecified. Defaults to `SYNCHRONOUS` if unspecified.",
"The tool is executed synchronously. The session is blocked until the tool returns.",
"The tool is executed asynchronously. The session will continue while the tool is executing."
],
"type": "string"
},
"mcpToolset": {
"$ref": "McpToolset",
"description": "Optional. A toolset that contains a list of tools that are offered by the MCP server."
},
"name": {
"description": "Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`",
"type": "string"
},
"openApiToolset": {
"$ref": "OpenApiToolset",
"description": "Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema."
},
"toolFakeConfig": {
"$ref": "ToolFakeConfig",
"description": "Optional. Configuration for tools behavior in fake mode."
},
"updateTime": {
"description": "Output only. Timestamp when the toolset was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ToolsetTool": {
"description": "A tool that is created from a toolset.",
"id": "ToolsetTool",
"properties": {
"toolId": {
"description": "Optional. The tool ID to filter the tools to retrieve the schema for.",
"type": "string"
},
"toolset": {
"description": "Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`",
"type": "string"
}
},
"type": "object"
},
"TransferRule": {
"description": "Rule for transferring to a specific agent.",
"id": "TransferRule",
"properties": {
"childAgent": {
"description": "Required. The resource name of the child agent the rule applies to. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
"type": "string"
},
"deterministicTransfer": {
"$ref": "TransferRuleDeterministicTransfer",
"description": "Optional. A rule that immediately transfers to the target agent when the condition is met."
},
"direction": {
"description": "Required. The direction of the transfer.",
"enum": [
"DIRECTION_UNSPECIFIED",
"PARENT_TO_CHILD",
"CHILD_TO_PARENT"
],
"enumDescriptions": [
"Unspecified direction.",
"Transfer from the parent agent to the child agent.",
"Transfer from the child agent to the parent agent."
],
"type": "string"
},
"disablePlannerTransfer": {
"$ref": "TransferRuleDisablePlannerTransfer",
"description": "Optional. Rule that prevents the planner from transferring to the target agent."
}
},
"type": "object"
},
"TransferRuleDeterministicTransfer": {
"description": "Deterministic transfer rule. When the condition evaluates to true, the transfer occurs.",
"id": "TransferRuleDeterministicTransfer",
"properties": {
"expressionCondition": {
"$ref": "ExpressionCondition",
"description": "Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs."
},
"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."
}
},
"type": "object"
},
"TransferRuleDisablePlannerTransfer": {
"description": "A rule that prevents the planner from transferring to the target agent.",
"id": "TransferRuleDisablePlannerTransfer",
"properties": {
"expressionCondition": {
"$ref": "ExpressionCondition",
"description": "Required. If the condition evaluates to true, planner will not be allowed to transfer to the target agent."
}
},
"type": "object"
},
"TriggerAction": {
"description": "Action that is taken when a certain precondition is met.",
"id": "TriggerAction",
"properties": {
"generativeAnswer": {
"$ref": "TriggerActionGenerativeAnswer",
"description": "Optional. Respond with a generative answer."
},
"respondImmediately": {
"$ref": "TriggerActionRespondImmediately",
"description": "Optional. Immediately respond with a preconfigured response."
},
"transferAgent": {
"$ref": "TriggerActionTransferAgent",
"description": "Optional. Transfer the conversation to a different agent."
}
},
"type": "object"
},
"TriggerActionGenerativeAnswer": {
"description": "The agent will immediately respond with a generative answer.",
"id": "TriggerActionGenerativeAnswer",
"properties": {
"prompt": {
"description": "Required. The prompt to use for the generative answer.",
"type": "string"
}
},
"type": "object"
},
"TriggerActionRespondImmediately": {
"description": "The agent will immediately respond with a preconfigured response.",
"id": "TriggerActionRespondImmediately",
"properties": {
"responses": {
"description": "Required. The canned responses for the agent to choose from. The response is chosen randomly.",
"items": {
"$ref": "TriggerActionResponse"
},
"type": "array"
}
},
"type": "object"
},
"TriggerActionResponse": {
"description": "Represents a response from the agent.",
"id": "TriggerActionResponse",
"properties": {
"disabled": {
"description": "Optional. Whether the response is disabled. Disabled responses are not used by the agent.",
"type": "boolean"
},
"text": {
"description": "Required. Text for the agent to respond with.",
"type": "string"
}
},
"type": "object"
},
"TriggerActionTransferAgent": {
"description": "The agent will transfer the conversation to a different agent.",
"id": "TriggerActionTransferAgent",
"properties": {
"agent": {
"description": "Required. The name of the agent to transfer the conversation to. The agent must be in the same app as the current agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
"type": "string"
}
},
"type": "object"
},
"UploadEvaluationAudioRequest": {
"description": "Request message for EvaluationService.UploadEvaluationAudio.",
"id": "UploadEvaluationAudioRequest",
"properties": {
"audioContent": {
"description": "Required. The raw audio bytes. The format of the audio must be single-channel LINEAR16 with a sample rate of 16kHz (default InputAudioConfig).",
"format": "byte",
"type": "string"
},
"previousAudioGcsUri": {
"description": "Optional. The Google Cloud Storage URI of the previously uploaded audio file to be deleted. Format: `gs:///`",
"type": "string"
}
},
"type": "object"
},
"UploadEvaluationAudioResponse": {
"description": "Response message for EvaluationService.UploadEvaluationAudio.",
"id": "UploadEvaluationAudioResponse",
"properties": {
"audioGcsUri": {
"description": "The Google Cloud Storage URI where the uploaded audio file is stored. Format: `gs:///`",
"type": "string"
},
"duration": {
"description": "The duration of the audio.",
"format": "google-duration",
"type": "string"
},
"transcript": {
"description": "The transcript of the audio, generated by Cloud Speech-to-Text.",
"type": "string"
}
},
"type": "object"
},
"WebSearchQuery": {
"description": "Represents a single web search query and its associated search uri.",
"id": "WebSearchQuery",
"properties": {
"query": {
"description": "The search query text.",
"type": "string"
},
"uri": {
"description": "The URI to the Google Search results page for the query.",
"type": "string"
}
},
"type": "object"
},
"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",
"properties": {
"dataMapping": {
"$ref": "WidgetToolDataMapping",
"description": "Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters."
},
"description": {
"description": "Optional. The description of the widget tool.",
"type": "string"
},
"name": {
"description": "Required. The display name of the widget tool.",
"type": "string"
},
"parameters": {
"$ref": "Schema",
"description": "Optional. The input parameters of the widget tool."
},
"textResponseConfig": {
"$ref": "WidgetToolTextResponseConfig",
"description": "Optional. Configuration for always-included text responses."
},
"uiConfig": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. Configuration for rendering the widget.",
"type": "object"
},
"widgetType": {
"description": "Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.",
"enum": [
"WIDGET_TYPE_UNSPECIFIED",
"CUSTOM",
"PRODUCT_CAROUSEL",
"PRODUCT_DETAILS",
"QUICK_ACTIONS",
"PRODUCT_COMPARISON",
"ADVANCED_PRODUCT_DETAILS",
"SHORT_FORM",
"OVERALL_SATISFACTION",
"ORDER_SUMMARY",
"APPOINTMENT_DETAILS",
"APPOINTMENT_SCHEDULER",
"CONTACT_FORM"
],
"enumDescriptions": [
"Unspecified widget type.",
"Custom widget type.",
"Product carousel widget.",
"Product details widget.",
"Quick actions widget.",
"Product comparison widget.",
"Advanced product details widget.",
"Short form widget.",
"Overall satisfaction widget.",
"Order summary widget.",
"Appointment details widget.",
"Appointment scheduler widget.",
"Contact form widget."
],
"type": "string"
}
},
"type": "object"
},
"WidgetToolDataMapping": {
"description": "Configuration for mapping data from a source tool to the widget's input parameters.",
"id": "WidgetToolDataMapping",
"properties": {
"fieldMappings": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.",
"type": "object"
},
"mode": {
"description": "Optional. The mode of the data mapping.",
"enum": [
"MODE_UNSPECIFIED",
"FIELD_MAPPING",
"PYTHON_SCRIPT"
],
"enumDescriptions": [
"Unspecified mode.",
"Use the `field_mappings` map for data transformation.",
"Use the `python_script` for data transformation."
],
"type": "string"
},
"pythonFunction": {
"$ref": "PythonFunction",
"description": "Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format."
},
"pythonScript": {
"deprecated": true,
"description": "Deprecated: Use `python_function` instead.",
"type": "string"
},
"sourceToolName": {
"description": "Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`",
"type": "string"
}
},
"type": "object"
},
"WidgetToolTextResponseConfig": {
"description": "Configuration for the text response returned with the widget.",
"id": "WidgetToolTextResponseConfig",
"properties": {
"staticText": {
"description": "Optional. The static text response to return when type is STATIC.",
"type": "string"
},
"textResponseInstruction": {
"description": "Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.",
"type": "string"
},
"type": {
"description": "Optional. The strategy for providing the text response.",
"enum": [
"TYPE_UNSPECIFIED",
"NONE",
"LLM_GENERATED",
"STATIC"
],
"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."
],
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Gemini Enterprise for Customer Experience API",
"version": "v1beta",
"version_module": true
}