{ "servicePath": "", "discoveryVersion": "v1", "title": "Gemini Enterprise for Customer Experience API", "canonicalName": "Customer Engagement Suite", "resources": { "projects": { "resources": { "locations": { "methods": { "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "description": "Gets information about a location.", "parameters": { "name": { "type": "string", "description": "Resource name for the location.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "id": "ces.projects.locations.get" }, "getSecuritySettings": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/securitySettings", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/securitySettings$", "location": "path", "description": "Required. The resource name of the security settings to retrieve. Format: `projects/{project}/locations/{location}/securitySettings`", "required": true } }, "response": { "$ref": "SecuritySettings" }, "description": "Retrieves the security settings for the project and location.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.getSecuritySettings" }, "updateSecuritySettings": { "request": { "$ref": "SecuritySettings" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/securitySettings", "id": "ces.projects.locations.updateSecuritySettings", "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated." }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/securitySettings$", "location": "path", "description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`", "required": true } }, "response": { "$ref": "SecuritySettings" }, "description": "Updates the security settings for the project and location.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ] }, "list": { "response": { "$ref": "ListLocationsResponse" }, "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32" }, "name": { "type": "string", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "description": "The resource that owns the locations collection, if applicable." }, "pageToken": { "location": "query", "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." }, "filter": { "location": "query", "type": "string", "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)." }, "extraLocationTypes": { "repeated": true, "location": "query", "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage." } }, "path": "v1beta/{+name}/locations", "parameterOrder": [ "name" ], "id": "ces.projects.locations.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations" } }, "resources": { "apps": { "methods": { "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. The resource name of the app to retrieve.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "response": { "$ref": "App" }, "description": "Gets details of the specified app.", "id": "ces.projects.locations.apps.get" }, "testPersonaVoice": { "request": { "$ref": "TestPersonaVoiceRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:testPersonaVoice", "id": "ces.projects.locations.apps.testPersonaVoice", "parameters": { "app": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "description": "Required. the resource name of the app to test the persona voice for. Format: `projects/{project}/locations/{location}/apps/{app}`" } }, "response": { "$ref": "TestPersonaVoiceResponse" }, "description": "Tests the voice of a persona. Also accepts a default persona.", "path": "v1beta/{+app}:testPersonaVoice", "parameterOrder": [ "app" ] }, "runEvaluation": { "request": { "$ref": "RunEvaluationRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:runEvaluation", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.runEvaluation", "path": "v1beta/{+app}:runEvaluation", "parameterOrder": [ "app" ], "parameters": { "app": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "description": "Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}`" } }, "response": { "$ref": "Operation" }, "description": "Runs an evaluation of the app." }, "importApp": { "id": "ces.projects.locations.apps.importApp", "path": "v1beta/{+parent}/apps:importApp", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "description": "Imports the specified app.", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource name with the location of the app to import." } }, "request": { "$ref": "ImportAppRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps:importApp", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "executeTool": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:executeTool", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ExecuteToolRequest" }, "path": "v1beta/{+parent}:executeTool", "parameterOrder": [ "parent" ], "response": { "$ref": "ExecuteToolResponse" }, "description": "Executes the given tool with the given arguments.", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true } }, "id": "ces.projects.locations.apps.executeTool" }, "exportApp": { "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the app to export." } }, "response": { "$ref": "Operation" }, "description": "Exports the specified app.", "path": "v1beta/{+name}:exportApp", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.exportApp", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:exportApp", "request": { "$ref": "ExportAppRequest" } }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.delete", "path": "v1beta/{+name}", "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": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to delete.", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "description": "Deletes the specified app." }, "list": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.list", "path": "v1beta/{+parent}/apps", "parameterOrder": [ "parent" ], "response": { "$ref": "ListAppsResponse" }, "description": "Lists apps in the given project and location.", "parameters": { "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListApps call.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details." }, "filter": { "description": "Optional. Filter to be applied when listing the apps. See https://google.aip.dev/160 for more details.", "location": "query", "type": "string" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The resource name of the location to list apps from.", "required": true } } }, "patch": { "id": "ces.projects.locations.apps.patch", "parameters": { "name": { "type": "string", "required": true, "description": "Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "updateMask": { "location": "query", "type": "string", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "format": "google-fieldmask" } }, "response": { "$ref": "App" }, "description": "Updates the specified app.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "request": { "$ref": "App" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}" }, "create": { "parameters": { "parent": { "required": true, "description": "Required. The resource name of the location to create an app in.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string" }, "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" } }, "response": { "$ref": "Operation" }, "description": "Creates a new app in the given project and location.", "path": "v1beta/{+parent}/apps", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.create", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps", "request": { "$ref": "App" } }, "generateAppResource": { "request": { "$ref": "GenerateAppResourceRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:generateAppResource", "id": "ces.projects.locations.apps.generateAppResource", "response": { "$ref": "Operation" }, "description": "Generates specific resources (e.g. agent) in the app using LLM assistant.", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the app to generate the resource for." } }, "path": "v1beta/{+parent}:generateAppResource", "parameterOrder": [ "parent" ] }, "importEvaluations": { "id": "ces.projects.locations.apps.importEvaluations", "path": "v1beta/{+parent}:importEvaluations", "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "description": "Required. The app to import the evaluations into. Format: `projects/{project}/locations/{location}/apps/{app}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" } }, "response": { "$ref": "Operation" }, "description": "Imports evaluations into the app.", "request": { "$ref": "ImportEvaluationsRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:importEvaluations", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "retrieveToolSchema": { "id": "ces.projects.locations.apps.retrieveToolSchema", "parameters": { "parent": { "description": "Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" } }, "response": { "$ref": "RetrieveToolSchemaResponse" }, "description": "Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.", "path": "v1beta/{+parent}:retrieveToolSchema", "parameterOrder": [ "parent" ], "request": { "$ref": "RetrieveToolSchemaRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:retrieveToolSchema" } }, "resources": { "tools": { "methods": { "get": { "id": "ces.projects.locations.apps.tools.get", "response": { "$ref": "Tool" }, "description": "Gets details of the specified tool.", "parameters": { "name": { "required": true, "description": "Required. The resource name of the tool to retrieve.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "location": "path", "type": "string" } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}" }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "response": { "$ref": "Empty" }, "description": "Deletes the specified tool.", "parameters": { "force": { "location": "query", "type": "boolean", "description": "Optional. Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples. * If `force = false`, the deletion will fail if any agents still reference the tool. * If `force = true`, all existing references from agents will be removed and the tool will be deleted." }, "etag": { "location": "query", "type": "string", "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." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "location": "path", "description": "Required. The resource name of the tool to delete.", "required": true, "type": "string" } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.tools.delete" }, "list": { "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" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListTools call." }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer" }, "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" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the app to list tools from.", "type": "string" } }, "response": { "$ref": "ListToolsResponse" }, "description": "Lists tools in the given app.", "path": "v1beta/{+parent}/tools", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.tools.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools" }, "create": { "request": { "$ref": "Tool" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools", "id": "ces.projects.locations.apps.tools.create", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to create a tool in.", "required": true, "type": "string" }, "toolId": { "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" } }, "response": { "$ref": "Tool" }, "description": "Creates a new tool in the given app.", "path": "v1beta/{+parent}/tools", "parameterOrder": [ "parent" ] }, "patch": { "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "request": { "$ref": "Tool" }, "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "location": "path", "required": true, "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." }, "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" } }, "response": { "$ref": "Tool" }, "description": "Updates the specified tool.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.tools.patch" } } }, "conversations": { "methods": { "batchDelete": { "id": "ces.projects.locations.apps.conversations.batchDelete", "response": { "$ref": "Operation" }, "description": "Batch deletes the specified conversations.", "parameters": { "parent": { "description": "Required. The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" } }, "path": "v1beta/{+parent}/conversations:batchDelete", "parameterOrder": [ "parent" ], "request": { "$ref": "BatchDeleteConversationsRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations:batchDelete" }, "generateEvaluation": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}:generateEvaluation", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GenerateEvaluationRequest" }, "path": "v1beta/{+conversation}:generateEvaluation", "parameterOrder": [ "conversation" ], "parameters": { "conversation": { "description": "Required. The conversation to create the golden evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$", "location": "path", "type": "string" } }, "response": { "$ref": "Operation" }, "description": "Creates a golden evaluation from a conversation.", "id": "ces.projects.locations.apps.conversations.generateEvaluation" }, "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}", "id": "ces.projects.locations.apps.conversations.get", "response": { "$ref": "Conversation" }, "description": "Gets details of the specified conversation.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The resource name of the conversation to retrieve.", "required": true, "type": "string" }, "source": { "type": "string", "deprecated": true, "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "location": "query", "description": "Optional. Indicate the source of the conversation. If not set, all source will be searched.", "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ] } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ] }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}", "id": "ces.projects.locations.apps.conversations.delete", "response": { "$ref": "Empty" }, "description": "Deletes the specified conversation.", "parameters": { "name": { "required": true, "description": "Required. The resource name of the conversation to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$", "location": "path", "type": "string" }, "source": { "location": "query", "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" ], "type": "string", "deprecated": true, "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ] } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations", "response": { "$ref": "ListConversationsResponse" }, "description": "Lists conversations in the given app.", "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" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer" }, "source": { "location": "query", "description": "Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of `sources` field.", "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "type": "string", "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ] }, "parent": { "type": "string", "description": "Required. The resource name of the app to list conversations from.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "sources": { "type": "string", "repeated": true, "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "location": "query", "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" ] } }, "path": "v1beta/{+parent}/conversations", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.conversations.list" } } }, "evaluations": { "methods": { "uploadEvaluationAudio": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}:uploadEvaluationAudio", "request": { "$ref": "UploadEvaluationAudioRequest" }, "response": { "$ref": "UploadEvaluationAudioResponse" }, "description": "Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript.", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the Evaluation for which to upload the evaluation audio. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`" } }, "path": "v1beta/{+name}:uploadEvaluationAudio", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.evaluations.uploadEvaluationAudio" }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}", "id": "ces.projects.locations.apps.evaluations.delete", "response": { "$ref": "Empty" }, "description": "Deletes an evaluation.", "parameters": { "name": { "required": true, "description": "Required. The resource name of the evaluation to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "location": "path", "type": "string" }, "etag": { "location": "query", "type": "string", "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." }, "force": { "location": "query", "type": "boolean", "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." } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ] }, "get": { "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Evaluation" }, "description": "Gets details of the specified evaluation.", "parameters": { "name": { "type": "string", "required": true, "description": "Required. The resource name of the evaluation to retrieve.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "location": "path" } }, "id": "ces.projects.locations.apps.evaluations.get", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "export": { "parameters": { "parent": { "type": "string", "description": "Required. The resource name of the app to export evaluations from. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "response": { "$ref": "Operation" }, "description": "Exports evaluations.", "path": "v1beta/{+parent}/evaluations:export", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.evaluations.export", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations:export", "request": { "$ref": "ExportEvaluationsRequest" } }, "list": { "id": "ces.projects.locations.apps.evaluations.list", "path": "v1beta/{+parent}/evaluations", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The resource name of the app to list evaluations from.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "lastTenResults": { "location": "query", "type": "boolean", "description": "Optional. Whether to include the last 10 evaluation results for each evaluation in the response." }, "evaluationFilter": { "location": "query", "type": "string", "description": "Optional. Filter to be applied on the evaluation when listing the evaluations. See https://google.aip.dev/160 for more details. Supported fields: evaluation_datasets" }, "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": { "location": "query", "type": "string", "description": "Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.", "deprecated": true }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\", and \"update_time\" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details." } }, "response": { "$ref": "ListEvaluationsResponse" }, "description": "Lists all evaluations in the given app.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "request": { "$ref": "Evaluation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations", "id": "ces.projects.locations.apps.evaluations.create", "parameters": { "evaluationId": { "location": "query", "type": "string", "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." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "type": "string" } }, "response": { "$ref": "Evaluation" }, "description": "Creates an evaluation.", "path": "v1beta/{+parent}/evaluations", "parameterOrder": [ "parent" ] }, "patch": { "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}", "request": { "$ref": "Evaluation" }, "parameters": { "name": { "type": "string", "required": true, "description": "Identifier. The unique identifier of this evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "location": "path" }, "updateMask": { "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" } }, "response": { "$ref": "Evaluation" }, "description": "Updates an evaluation.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.evaluations.patch" } }, "resources": { "results": { "methods": { "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the evaluation to list evaluation results from. To filter by evaluation run, use `-` as the evaluation ID and specify the evaluation run ID in the filter. For example: `projects/{project}/locations/{location}/apps/{app}/evaluations/-`" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationResults call." }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\", and \"update_time\" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details." }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter to be applied when listing the evaluation results. See https://google.aip.dev/160 for more details." } }, "response": { "$ref": "ListEvaluationResultsResponse" }, "description": "Lists all evaluation results for a given evaluation.", "path": "v1beta/{+parent}/results", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.evaluations.results.list" }, "export": { "request": { "$ref": "ExportEvaluationResultsRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results:export", "id": "ces.projects.locations.apps.evaluations.results.export", "response": { "$ref": "Operation" }, "description": "Exports evaluations results.", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "location": "path", "description": "Required. The resource name of the evaluation to export evaluation results from. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "required": true } }, "path": "v1beta/{+parent}/results:export", "parameterOrder": [ "parent" ] }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}", "id": "ces.projects.locations.apps.evaluations.results.delete", "response": { "$ref": "Empty" }, "description": "Deletes an evaluation result.", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$", "location": "path", "description": "Required. The resource name of the evaluation result to delete.", "required": true } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ] }, "get": { "id": "ces.projects.locations.apps.evaluations.results.get", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "EvaluationResult" }, "description": "Gets details of the specified evaluation result.", "parameters": { "name": { "description": "Required. The resource name of the evaluation result to retrieve.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$", "location": "path", "type": "string" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "toolsets": { "methods": { "create": { "request": { "$ref": "Toolset" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets", "id": "ces.projects.locations.apps.toolsets.create", "response": { "$ref": "Toolset" }, "description": "Creates a new toolset in the given app.", "parameters": { "parent": { "type": "string", "description": "Required. The resource name of the app to create a toolset in.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "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", "parameterOrder": [ "parent" ] }, "patch": { "id": "ces.projects.locations.apps.toolsets.patch", "response": { "$ref": "Toolset" }, "description": "Updates the specified toolset.", "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated." }, "name": { "type": "string", "required": true, "description": "Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "location": "path" } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "request": { "$ref": "Toolset" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}" }, "retrieveTools": { "response": { "$ref": "RetrieveToolsResponse" }, "description": "Retrieve the list of tools included in the specified toolset.", "parameters": { "toolset": { "type": "string", "required": true, "description": "Required. The name of the toolset to retrieve the tools for. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "location": "path" } }, "path": "v1beta/{+toolset}:retrieveTools", "parameterOrder": [ "toolset" ], "id": "ces.projects.locations.apps.toolsets.retrieveTools", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}:retrieveTools", "request": { "$ref": "RetrieveToolsRequest" } }, "get": { "parameters": { "name": { "type": "string", "required": true, "description": "Required. The resource name of the toolset to retrieve.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "location": "path" } }, "response": { "$ref": "Toolset" }, "description": "Gets details of the specified toolset.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.toolsets.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}" }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.toolsets.delete", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. The resource name of the toolset to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "location": "path" }, "etag": { "location": "query", "type": "string", "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." }, "force": { "location": "query", "type": "boolean", "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." } }, "response": { "$ref": "Empty" }, "description": "Deletes the specified toolset." }, "list": { "id": "ces.projects.locations.apps.toolsets.list", "response": { "$ref": "ListToolsetsResponse" }, "description": "Lists toolsets in the given app.", "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" }, "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" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details." }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListToolsets call." }, "parent": { "type": "string", "description": "Required. The resource name of the app to list toolsets from.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "path": "v1beta/{+parent}/toolsets", "parameterOrder": [ "parent" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets" } } }, "evaluationDatasets": { "methods": { "delete": { "path": "v1beta/{+name}", "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": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$", "location": "path", "description": "Required. The resource name of the evaluation dataset to delete.", "required": true } }, "response": { "$ref": "Empty" }, "description": "Deletes an evaluation dataset.", "id": "ces.projects.locations.apps.evaluationDatasets.delete", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationDatasets.get", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "EvaluationDataset" }, "description": "Gets details of the specified evaluation dataset.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the evaluation dataset to retrieve.", "type": "string" } } }, "list": { "path": "v1beta/{+parent}/evaluationDatasets", "parameterOrder": [ "parent" ], "parameters": { "filter": { "location": "query", "type": "string", "description": "Optional. Filter to be applied when listing the evaluation datasets. See https://google.aip.dev/160 for more details." }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer" }, "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" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationDatasets call." }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to list evaluation datasets from.", "required": true } }, "response": { "$ref": "ListEvaluationDatasetsResponse" }, "description": "Lists all evaluation datasets in the given app.", "id": "ces.projects.locations.apps.evaluationDatasets.list", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "id": "ces.projects.locations.apps.evaluationDatasets.create", "response": { "$ref": "EvaluationDataset" }, "description": "Creates an evaluation dataset.", "parameters": { "parent": { "type": "string", "description": "Required. The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "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" } }, "path": "v1beta/{+parent}/evaluationDatasets", "parameterOrder": [ "parent" ], "request": { "$ref": "EvaluationDataset" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets" }, "patch": { "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}", "request": { "$ref": "EvaluationDataset" }, "parameters": { "name": { "type": "string", "required": true, "description": "Identifier. The unique identifier of this evaluation dataset. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$", "location": "path" }, "updateMask": { "location": "query", "type": "string", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "format": "google-fieldmask" } }, "response": { "$ref": "EvaluationDataset" }, "description": "Updates an evaluation dataset.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.evaluationDatasets.patch" } } }, "versions": { "methods": { "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions", "id": "ces.projects.locations.apps.versions.list", "response": { "$ref": "ListAppVersionsResponse" }, "description": "Lists all app versions in the given app.", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to list app versions from.", "required": true, "type": "string" }, "pageSize": { "location": "query", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32" }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListAppVersions call.", "location": "query", "type": "string" }, "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" } }, "path": "v1beta/{+parent}/versions", "parameterOrder": [ "parent" ] }, "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}", "response": { "$ref": "AppVersion" }, "description": "Gets details of the specified app version.", "parameters": { "name": { "type": "string", "required": true, "description": "Required. The resource name of the app version to retrieve.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "location": "path" } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.versions.get" }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "Deletes the specified app version.", "parameters": { "name": { "type": "string", "required": true, "description": "Required. The resource name of the app version to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "location": "path" }, "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" } }, "id": "ces.projects.locations.apps.versions.delete" }, "restore": { "id": "ces.projects.locations.apps.versions.restore", "path": "v1beta/{+name}:restore", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "location": "path", "description": "Required. The resource name of the app version to restore.", "required": true, "type": "string" } }, "request": { "$ref": "RestoreAppVersionRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}:restore", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "path": "v1beta/{+parent}/versions", "parameterOrder": [ "parent" ], "response": { "$ref": "AppVersion" }, "description": "Creates a new app version in the given app.", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to create an app version in.", "required": true, "type": "string" }, "appVersionId": { "location": "query", "type": "string", "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." } }, "id": "ces.projects.locations.apps.versions.create", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "AppVersion" } } } }, "scheduledEvaluationRuns": { "methods": { "create": { "path": "v1beta/{+parent}/scheduledEvaluationRuns", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The app to create the scheduled evaluation run for. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "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" } }, "response": { "$ref": "ScheduledEvaluationRun" }, "description": "Creates a scheduled evaluation run.", "id": "ces.projects.locations.apps.scheduledEvaluationRuns.create", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ScheduledEvaluationRun" } }, "patch": { "request": { "$ref": "ScheduledEvaluationRun" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.scheduledEvaluationRuns.patch", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "format": "google-fieldmask", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$", "location": "path", "description": "Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}", "required": true, "type": "string" } }, "response": { "$ref": "ScheduledEvaluationRun" }, "description": "Updates a scheduled evaluation run." }, "list": { "path": "v1beta/{+parent}/scheduledEvaluationRuns", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to list scheduled evaluation runs from.", "required": true, "type": "string" }, "filter": { "location": "query", "type": "string", "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" }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer" }, "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" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListScheduledEvaluationRuns call.", "location": "query", "type": "string" } }, "response": { "$ref": "ListScheduledEvaluationRunsResponse" }, "description": "Lists all scheduled evaluation runs in the given app.", "id": "ces.projects.locations.apps.scheduledEvaluationRuns.list", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the scheduled evaluation run to retrieve." } }, "response": { "$ref": "ScheduledEvaluationRun" }, "description": "Gets details of the specified scheduled evaluation run.", "id": "ces.projects.locations.apps.scheduledEvaluationRuns.get" }, "delete": { "id": "ces.projects.locations.apps.scheduledEvaluationRuns.delete", "parameters": { "etag": { "location": "query", "type": "string", "description": "Optional. The etag of the ScheduledEvaluationRun. If provided, it must match the server's etag." }, "name": { "description": "Required. The resource name of the scheduled evaluation run to delete.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$", "location": "path", "type": "string" } }, "response": { "$ref": "Empty" }, "description": "Deletes a scheduled evaluation run.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}" } } }, "agents": { "methods": { "create": { "path": "v1beta/{+parent}/agents", "parameterOrder": [ "parent" ], "parameters": { "agentId": { "location": "query", "type": "string", "description": "Optional. The ID to use for the agent, which will become the final component of the agent's resource name. If not provided, a unique ID will be automatically assigned for the agent." }, "parent": { "type": "string", "description": "Required. The resource name of the app to create an agent in.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "response": { "$ref": "Agent" }, "description": "Creates a new agent in the given app.", "id": "ces.projects.locations.apps.agents.create", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Agent" } }, "patch": { "id": "ces.projects.locations.apps.agents.patch", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Agent" }, "description": "Updates the specified agent.", "parameters": { "updateMask": { "location": "query", "type": "string", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "format": "google-fieldmask" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "location": "path", "description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "required": true } }, "request": { "$ref": "Agent" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}", "id": "ces.projects.locations.apps.agents.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "location": "path", "description": "Required. The resource name of the agent to retrieve.", "required": true, "type": "string" } }, "response": { "$ref": "Agent" }, "description": "Gets details of the specified agent.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ] }, "delete": { "id": "ces.projects.locations.apps.agents.delete", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "Deletes the specified agent.", "parameters": { "name": { "type": "string", "description": "Required. The resource name of the agent to delete.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "location": "path" }, "etag": { "location": "query", "type": "string", "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." }, "force": { "location": "query", "type": "boolean", "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." } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents", "id": "ces.projects.locations.apps.agents.list", "parameters": { "parent": { "type": "string", "description": "Required. The resource name of the app to list agents from.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListAgents call.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details." }, "filter": { "description": "Optional. Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details.", "location": "query", "type": "string" } }, "response": { "$ref": "ListAgentsResponse" }, "description": "Lists agents in the given app.", "path": "v1beta/{+parent}/agents", "parameterOrder": [ "parent" ] } } }, "evaluationRuns": { "methods": { "export": { "parameters": { "parent": { "description": "Required. The resource name of the app to export evaluation runs from. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" } }, "response": { "$ref": "Operation" }, "description": "Exports evaluations runs.", "path": "v1beta/{+parent}/evaluationRuns:export", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.evaluationRuns.export", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns:export", "request": { "$ref": "ExportEvaluationRunsRequest" } }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns/{evaluationRunsId}", "id": "ces.projects.locations.apps.evaluationRuns.delete", "response": { "$ref": "Operation" }, "description": "Deletes an evaluation run.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationRuns/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the evaluation run to delete.", "type": "string" } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ] }, "get": { "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "EvaluationRun" }, "description": "Gets details of the specified evaluation run.", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationRuns/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the evaluation run to retrieve." } }, "id": "ces.projects.locations.apps.evaluationRuns.get", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns/{evaluationRunsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns", "response": { "$ref": "ListEvaluationRunsResponse" }, "description": "Lists all evaluation runs in the given app.", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationRuns call." }, "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" }, "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" }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter to be applied when listing the evaluation runs. See https://google.aip.dev/160 for more details." }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to list evaluation runs from.", "required": true } }, "path": "v1beta/{+parent}/evaluationRuns", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.evaluationRuns.list" } } }, "sessions": { "methods": { "runSession": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:runSession", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "RunSessionRequest" }, "path": "v1beta/{+session}:runSession", "parameterOrder": [ "session" ], "response": { "$ref": "RunSessionResponse" }, "description": "Initiates a single-turn interaction with the CES agent within a session.", "parameters": { "session": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "location": "path", "description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`", "required": true } }, "id": "ces.projects.locations.apps.sessions.runSession" }, "streamRunSession": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:streamRunSession", "request": { "$ref": "RunSessionRequest" }, "parameters": { "session": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "location": "path", "description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`", "required": true } }, "response": { "$ref": "RunSessionResponse" }, "description": "Initiates a single-turn interaction with the CES agent. Uses server-side streaming to deliver incremental results and partial responses as they are generated. By default, complete responses (e.g., messages from callbacks or full LLM responses) are sent to the client as soon as they are available. To enable streaming individual text chunks directly from the model, set enable_text_streaming to true.", "path": "v1beta/{+session}:streamRunSession", "parameterOrder": [ "session" ], "id": "ces.projects.locations.apps.sessions.streamRunSession" }, "generateChatToken": { "id": "ces.projects.locations.apps.sessions.generateChatToken", "response": { "$ref": "GenerateChatTokenResponse" }, "description": "Generates a session scoped token for chat widget to authenticate with Session APIs.", "parameters": { "name": { "description": "Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "location": "path", "type": "string" } }, "path": "v1beta/{+name}:generateChatToken", "parameterOrder": [ "name" ], "request": { "$ref": "GenerateChatTokenRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:generateChatToken" } } }, "examples": { "methods": { "create": { "request": { "$ref": "Example" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples", "id": "ces.projects.locations.apps.examples.create", "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": { "type": "string", "description": "Required. The resource name of the app to create an example in.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "response": { "$ref": "Example" }, "description": "Creates a new example in the given app.", "path": "v1beta/{+parent}/examples", "parameterOrder": [ "parent" ] }, "patch": { "request": { "$ref": "Example" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}", "id": "ces.projects.locations.apps.examples.patch", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$", "location": "path", "description": "Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`", "required": true, "type": "string" }, "updateMask": { "location": "query", "type": "string", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "format": "google-fieldmask" } }, "response": { "$ref": "Example" }, "description": "Updates the specified example.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ] }, "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.examples.get", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The resource name of the example to retrieve.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$", "location": "path", "type": "string" } }, "response": { "$ref": "Example" }, "description": "Gets details of the specified example." }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "Deletes the specified example.", "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.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$", "location": "path", "type": "string" } }, "id": "ces.projects.locations.apps.examples.delete" }, "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples", "response": { "$ref": "ListExamplesResponse" }, "description": "Lists examples in the given app.", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the app to list examples from." }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListExamples call." }, "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" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details." }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details." } }, "path": "v1beta/{+parent}/examples", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.examples.list" } } }, "guardrails": { "methods": { "create": { "request": { "$ref": "Guardrail" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails", "id": "ces.projects.locations.apps.guardrails.create", "parameters": { "parent": { "type": "string", "description": "Required. The resource name of the app to create a guardrail in.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "guardrailId": { "description": "Optional. The ID to use for the guardrail, which will become the final component of the guardrail's resource name. If not provided, a unique ID will be automatically assigned for the guardrail.", "location": "query", "type": "string" } }, "response": { "$ref": "Guardrail" }, "description": "Creates a new guardrail in the given app.", "path": "v1beta/{+parent}/guardrails", "parameterOrder": [ "parent" ] }, "patch": { "id": "ces.projects.locations.apps.guardrails.patch", "response": { "$ref": "Guardrail" }, "description": "Updates the specified guardrail.", "parameters": { "name": { "required": true, "description": "Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "location": "path", "type": "string" }, "updateMask": { "location": "query", "type": "string", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "format": "google-fieldmask" } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "request": { "$ref": "Guardrail" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}" }, "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "location": "path", "description": "Required. The resource name of the guardrail to retrieve.", "required": true, "type": "string" } }, "response": { "$ref": "Guardrail" }, "description": "Gets details of the specified guardrail.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.guardrails.get" }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "id": "ces.projects.locations.apps.guardrails.delete", "response": { "$ref": "Empty" }, "description": "Deletes the specified guardrail.", "parameters": { "force": { "description": "Optional. Indicates whether to forcefully delete the guardrail, even if it is still referenced by app/agents. * If `force = false`, the deletion fails if any apps/agents still reference the guardrail. * If `force = true`, all existing references from apps/agents will be removed and the guardrail will be deleted.", "location": "query", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the guardrail to delete.", "type": "string" }, "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" } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ] }, "list": { "id": "ces.projects.locations.apps.guardrails.list", "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" }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details." }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListGuardrails call.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the app to list guardrails from.", "type": "string" } }, "response": { "$ref": "ListGuardrailsResponse" }, "description": "Lists guardrails in the given app.", "path": "v1beta/{+parent}/guardrails", "parameterOrder": [ "parent" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails" } } }, "deployments": { "methods": { "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "id": "ces.projects.locations.apps.deployments.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "location": "path", "description": "Required. The name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "required": true, "type": "string" } }, "response": { "$ref": "Deployment" }, "description": "Gets details of the specified deployment.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ] }, "delete": { "id": "ces.projects.locations.apps.deployments.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "location": "path", "description": "Required. The name of the deployment to delete. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "required": true, "type": "string" }, "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" } }, "response": { "$ref": "Empty" }, "description": "Deletes the specified deployment.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}" }, "list": { "id": "ces.projects.locations.apps.deployments.list", "path": "v1beta/{+parent}/deployments", "parameterOrder": [ "parent" ], "response": { "$ref": "ListDeploymentsResponse" }, "description": "Lists deployments in the given app.", "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "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." }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" }, "pageToken": { "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": { "type": "string", "description": "Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "request": { "$ref": "Deployment" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments", "id": "ces.projects.locations.apps.deployments.create", "response": { "$ref": "Deployment" }, "description": "Creates a new deployment in the given app.", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "description": "Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`" }, "deploymentId": { "location": "query", "type": "string", "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." } }, "path": "v1beta/{+parent}/deployments", "parameterOrder": [ "parent" ] }, "patch": { "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`" }, "updateMask": { "location": "query", "type": "string", "description": "Optional. The list of fields to update.", "format": "google-fieldmask" } }, "response": { "$ref": "Deployment" }, "description": "Updates the specified deployment.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.deployments.patch", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "request": { "$ref": "Deployment" } } } }, "changelogs": { "methods": { "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs", "id": "ces.projects.locations.apps.changelogs.list", "response": { "$ref": "ListChangelogsResponse" }, "description": "Lists the changelogs of the specified app.", "parameters": { "parent": { "description": "Required. The resource name of the app to list changelogs from.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListChangelogs call.", "location": "query", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter to be applied when listing the changelogs. See https://google.aip.dev/160 for more details. The filter string can be used to filter by `action`, `resource_type`, `resource_name`, `author`, and `create_time`. The `:` comparator can be used for case-insensitive partial matching on string fields, while `=` performs an exact case-sensitive match. Examples: * `action:update` (case-insensitive partial match) * `action=\"Create\"` (case-sensitive exact match) * `resource_type:agent` * `resource_name:my-agent` * `author:me@example.com` * `create_time \u003e \"2025-01-01T00:00:00Z\"` * `create_time \u003c= \"2025-01-01T00:00:00Z\" AND resource_type:tool`" } }, "path": "v1beta/{+parent}/changelogs", "parameterOrder": [ "parent" ] }, "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs/{changelogsId}", "id": "ces.projects.locations.apps.changelogs.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/changelogs/[^/]+$", "location": "path", "description": "Required. The resource name of the changelog to retrieve.", "required": true, "type": "string" } }, "response": { "$ref": "Changelog" }, "description": "Gets the specified changelog.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ] } } }, "evaluationExpectations": { "methods": { "create": { "path": "v1beta/{+parent}/evaluationExpectations", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The app to create the evaluation expectation for. Format: `projects/{project}/locations/{location}/apps/{app}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "evaluationExpectationId": { "location": "query", "type": "string", "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." } }, "response": { "$ref": "EvaluationExpectation" }, "description": "Creates an evaluation expectation.", "id": "ces.projects.locations.apps.evaluationExpectations.create", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "EvaluationExpectation" } }, "patch": { "id": "ces.projects.locations.apps.evaluationExpectations.patch", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "parameters": { "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" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$", "location": "path", "description": "Identifier. The unique identifier of this evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`", "required": true } }, "response": { "$ref": "EvaluationExpectation" }, "description": "Updates an evaluation expectation.", "request": { "$ref": "EvaluationExpectation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationExpectations.list", "path": "v1beta/{+parent}/evaluationExpectations", "parameterOrder": [ "parent" ], "response": { "$ref": "ListEvaluationExpectationsResponse" }, "description": "Lists all evaluation expectations in the given app.", "parameters": { "parent": { "type": "string", "description": "Required. The resource name of the app to list evaluation expectations from.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "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" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationExpectations call.", "location": "query", "type": "string" }, "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" } } }, "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.evaluationExpectations.get", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "EvaluationExpectation" }, "description": "Gets details of the specified evaluation expectation.", "parameters": { "name": { "type": "string", "required": true, "description": "Required. The resource name of the evaluation expectation to retrieve.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$", "location": "path" } } }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the evaluation expectation to delete.", "type": "string" }, "etag": { "location": "query", "type": "string", "description": "Optional. The current etag of the evaluation expectation. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the evaluation expectation, deletion will be blocked and an ABORTED error will be returned." } }, "response": { "$ref": "Empty" }, "description": "Deletes an evaluation expectation.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.evaluationExpectations.delete" } } } } }, "operations": { "methods": { "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.operations.get", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation resource." } }, "response": { "$ref": "Operation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "response": { "$ref": "Empty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.operations.delete" }, "list": { "path": "v1beta/{+name}/operations", "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The standard list page size." }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation's parent resource." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "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." } }, "id": "ces.projects.locations.operations.list", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation resource to be cancelled.", "type": "string" } }, "response": { "$ref": "Empty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta/{+name}:cancel", "parameterOrder": [ "name" ], "id": "ces.projects.locations.operations.cancel", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "request": { "$ref": "CancelOperationRequest" } } } } } } } } }, "fullyEncodeReservedExpansion": true, "rootUrl": "https://ces.googleapis.com/", "mtlsRootUrl": "https://ces.mtls.googleapis.com/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "version": "v1beta", "batchPath": "batch", "baseUrl": "https://ces.googleapis.com/", "ownerDomain": "google.com", "id": "ces:v1beta", "ownerName": "Google", "description": "", "revision": "20260506", "schemas": { "UploadEvaluationAudioRequest": { "type": "object", "id": "UploadEvaluationAudioRequest", "description": "Request message for EvaluationService.UploadEvaluationAudio.", "properties": { "audioContent": { "type": "string", "format": "byte", "description": "Required. The raw audio bytes. The format of the audio must be single-channel LINEAR16 with a sample rate of 16kHz (default InputAudioConfig)." }, "previousAudioGcsUri": { "description": "Optional. The Google Cloud Storage URI of the previously uploaded audio file to be deleted. Format: `gs:///`", "type": "string" } } }, "PythonFunction": { "id": "PythonFunction", "type": "object", "properties": { "pythonCode": { "description": "Optional. The Python code to execute for the tool.", "type": "string" }, "description": { "readOnly": true, "type": "string", "description": "Output only. The description of the Python function, parsed from the python code's docstring." }, "name": { "description": "Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.", "type": "string" } }, "description": "A Python function tool." }, "FileContext": { "properties": { "fileBytes": { "description": "Optional. File provided as raw bytes.", "$ref": "FileContextFileBytes" } }, "description": "Files to be used as context. Files can be provided as raw bytes.", "id": "FileContext", "type": "object" }, "EvaluationMetricsConfigHallucinationMetricsConfig": { "id": "EvaluationMetricsConfigHallucinationMetricsConfig", "type": "object", "properties": { "enableHallucinationMetrics": { "description": "Optional. Whether to calculate hallucination metrics for the evaluation.", "type": "boolean" } }, "description": "Configuration for the hallucination metrics for the evaluation. To disable the metric, set the message but do not set the `enable_hallucination_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely." }, "EvaluationMetricsConfigGoldenMetricsConfig": { "properties": { "toolCorrectnessMetricsConfig": { "description": "Optional. Configuration for turn level tool correctness metrics.", "$ref": "EvaluationMetricsConfigToolCorrectnessMetricsConfig" }, "semanticSimilarityMetricsConfig": { "description": "Optional. Global configuration for semantic similarity metrics.", "$ref": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig" }, "stepToolCorrectnessMetricsConfig": { "description": "Optional. Configuration for step level tool correctness metrics.", "$ref": "EvaluationMetricsConfigToolCorrectnessMetricsConfig" } }, "description": "Configuration for the golden metrics for the evaluation.", "id": "EvaluationMetricsConfigGoldenMetricsConfig", "type": "object" }, "ToolResponse": { "description": "The execution result of a specific tool from the client or the agent.", "properties": { "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "response": { "description": "Required. The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "toolsetTool": { "description": "Optional. The toolset tool that got executed.", "$ref": "ToolsetTool" }, "id": { "description": "Optional. The matching ID of the tool call the response is for.", "type": "string" }, "displayName": { "description": "Output only. Display name of the tool.", "readOnly": true, "type": "string" } }, "type": "object", "id": "ToolResponse" }, "AggregatedMetricsMetricsByAppVersion": { "description": "Metrics aggregated per app version.", "properties": { "appVersionId": { "description": "Output only. The app version ID.", "readOnly": true, "type": "string" }, "toolMetrics": { "description": "Output only. Metrics for each tool within this app version.", "readOnly": true, "type": "array", "items": { "$ref": "AggregatedMetricsToolMetrics" } }, "turnLatencyMetrics": { "description": "Output only. Metrics for turn latency within this app version.", "readOnly": true, "type": "array", "items": { "$ref": "AggregatedMetricsTurnLatencyMetrics" } }, "semanticSimilarityMetrics": { "items": { "$ref": "AggregatedMetricsSemanticSimilarityMetrics" }, "readOnly": true, "type": "array", "description": "Output only. Metrics for semantic similarity within this app version." }, "failCount": { "description": "Output only. The number of times the evaluation failed.", "format": "int32", "readOnly": true, "type": "integer" }, "passCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The number of times the evaluation passed." }, "metricsByTurn": { "description": "Output only. Metrics aggregated per turn within this app version.", "items": { "$ref": "AggregatedMetricsMetricsByTurn" }, "readOnly": true, "type": "array" }, "toolCallLatencyMetrics": { "items": { "$ref": "AggregatedMetricsToolCallLatencyMetrics" }, "readOnly": true, "type": "array", "description": "Output only. Metrics for tool call latency within this app version." }, "hallucinationMetrics": { "description": "Output only. Metrics for hallucination within this app version.", "readOnly": true, "type": "array", "items": { "$ref": "AggregatedMetricsHallucinationMetrics" } } }, "type": "object", "id": "AggregatedMetricsMetricsByAppVersion" }, "ImportEvaluationsOperationMetadata": { "id": "ImportEvaluationsOperationMetadata", "type": "object", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "statusMessage": { "readOnly": true, "type": "string", "description": "Output only. Human-readable status of the operation, if any." }, "endTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation finished running.", "format": "google-datetime" } }, "description": "Represents the metadata of the long-running operation for EvaluationService.ImportEvaluations." }, "ServiceAgentIdTokenAuthConfig": { "properties": {}, "description": "Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent.", "id": "ServiceAgentIdTokenAuthConfig", "type": "object" }, "EvaluationResultScenarioExpectationOutcome": { "type": "object", "id": "EvaluationResultScenarioExpectationOutcome", "description": "The outcome of a scenario expectation.", "properties": { "observedToolCall": { "readOnly": true, "description": "Output only. The observed tool call.", "$ref": "EvaluationResultScenarioExpectationOutcomeObservedToolCall" }, "observedAgentResponse": { "description": "Output only. The observed agent response.", "$ref": "Message", "readOnly": true }, "outcome": { "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", "description": "Output only. The outcome of the ScenarioExpectation.", "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ] }, "expectation": { "description": "Output only. The expectation that was evaluated.", "$ref": "EvaluationScenarioExpectation", "readOnly": true } } }, "TransferRuleDisablePlannerTransfer": { "properties": { "expressionCondition": { "description": "Required. If the condition evaluates to true, planner will not be allowed to transfer to the target agent.", "$ref": "ExpressionCondition" } }, "description": "A rule that prevents the planner from transferring to the target agent.", "id": "TransferRuleDisablePlannerTransfer", "type": "object" }, "RedactionConfig": { "type": "object", "id": "RedactionConfig", "description": "Configuration to instruct how sensitive data should be handled.", "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" } } }, "AggregatedMetricsTurnLatencyMetrics": { "description": "Metrics for turn latency.", "properties": { "averageLatency": { "readOnly": true, "type": "string", "format": "google-duration", "description": "Output only. The average latency of the turns." } }, "type": "object", "id": "AggregatedMetricsTurnLatencyMetrics" }, "RunSessionResponse": { "properties": { "outputs": { "description": "Outputs for the session.", "type": "array", "items": { "$ref": "SessionOutput" } } }, "description": "Response message for SessionService.RunSession.", "id": "RunSessionResponse", "type": "object" }, "TestPersonaVoiceResponse": { "id": "TestPersonaVoiceResponse", "type": "object", "properties": { "audio": { "type": "string", "format": "byte", "description": "The audio data bytes of the synthesized voice." } }, "description": "Response message for EvaluationService.TestPersonaVoice." }, "ExecuteToolResponse": { "id": "ExecuteToolResponse", "type": "object", "properties": { "tool": { "description": "The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "variables": { "description": "The variable values at the end of the tool execution.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "response": { "type": "object", "description": "The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "toolsetTool": { "description": "The toolset tool that got executed.", "$ref": "ToolsetTool" } }, "description": "Response message for ToolService.ExecuteTool." }, "AgentAgentToolset": { "properties": { "toolIds": { "items": { "type": "string" }, "type": "array", "description": "Optional. The tools IDs to filter the toolset." }, "toolset": { "description": "Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string" } }, "description": "A toolset with a selection of its tools.", "id": "AgentAgentToolset", "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.", "properties": { "webhookHeaders": { "type": "object", "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).", "additionalProperties": { "type": "string" } }, "endUserMetadata": { "type": "object", "description": "Optional. The end user metadata to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "payload": { "type": "object", "description": "Optional. The payload to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "type": "object", "id": "SessionConfigRemoteDialogflowQueryParameters" }, "ExperimentConfigVersionRelease": { "properties": { "state": { "type": "string", "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." ] }, "trafficAllocations": { "description": "Optional. Traffic allocations for the version release.", "type": "array", "items": { "$ref": "ExperimentConfigVersionReleaseTrafficAllocation" } } }, "description": "Version release for the experiment.", "id": "ExperimentConfigVersionRelease", "type": "object" }, "TriggerActionResponse": { "description": "Represents a response from the agent.", "properties": { "text": { "description": "Required. Text for the agent to respond with.", "type": "string" }, "disabled": { "description": "Optional. Whether the response is disabled. Disabled responses are not used by the agent.", "type": "boolean" } }, "type": "object", "id": "TriggerActionResponse" }, "LoggingSettings": { "description": "Settings to describe the logging behaviors for the app.", "properties": { "cloudLoggingSettings": { "description": "Optional. Settings to describe the Cloud Logging behaviors for the app.", "$ref": "CloudLoggingSettings" }, "metricAnalysisSettings": { "description": "Optional. Settings to describe the conversation data collection behaviors for the LLM analysis pipeline for the app.", "$ref": "MetricAnalysisSettings" }, "redactionConfig": { "description": "Optional. Configuration for how sensitive data should be redacted.", "$ref": "RedactionConfig" }, "audioRecordingConfig": { "description": "Optional. Configuration for how audio interactions should be recorded.", "$ref": "AudioRecordingConfig" }, "conversationLoggingSettings": { "description": "Optional. Settings to describe the conversation logging behaviors for the app.", "$ref": "ConversationLoggingSettings" }, "evaluationAudioRecordingConfig": { "description": "Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions.", "$ref": "AudioRecordingConfig" }, "unredactedAudioRecordingConfig": { "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.", "$ref": "AudioRecordingConfig" }, "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.", "$ref": "BigQueryExportSettings" } }, "type": "object", "id": "LoggingSettings" }, "TriggerAction": { "type": "object", "id": "TriggerAction", "description": "Action that is taken when a certain precondition is met.", "properties": { "respondImmediately": { "description": "Optional. Immediately respond with a preconfigured response.", "$ref": "TriggerActionRespondImmediately" }, "generativeAnswer": { "description": "Optional. Respond with a generative answer.", "$ref": "TriggerActionGenerativeAnswer" }, "transferAgent": { "description": "Optional. Transfer the conversation to a different agent.", "$ref": "TriggerActionTransferAgent" } } }, "EvaluationConfig": { "description": "EvaluationConfig configures settings for running the evaluation.", "properties": { "outputAudioConfig": { "description": "Optional. Configuration for generating the output audio.", "$ref": "OutputAudioConfig", "deprecated": true }, "evaluationChannel": { "type": "string", "description": "Optional. The channel to evaluate.", "enum": [ "EVALUATION_CHANNEL_UNSPECIFIED", "TEXT", "AUDIO" ], "enumDescriptions": [ "Unspecified evaluation channel.", "Text-only evaluation channel.", "Audio evaluation channel." ] }, "inputAudioConfig": { "description": "Optional. Configuration for processing the input audio.", "$ref": "InputAudioConfig", "deprecated": true }, "toolCallBehaviour": { "type": "string", "enumDescriptions": [ "Unspecified tool call behavior. Will default to real tool calls.", "Use real tool calls.", "Use fake tool calls." ], "description": "Optional. Specifies whether the evaluation should use real tool calls or fake tools.", "enum": [ "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED", "REAL", "FAKE" ] } }, "type": "object", "id": "EvaluationConfig" }, "ImportAppRequestImportOptions": { "id": "ImportAppRequestImportOptions", "type": "object", "properties": { "conflictResolutionStrategy": { "type": "string", "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." ] } }, "description": "Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data." }, "ImportEvaluationsRequestImportOptions": { "description": "Configuration options for the evaluation import process. These options control how the import behaves, particularly when conflicts arise with existing evaluations data.", "properties": { "conflictResolutionStrategy": { "type": "string", "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": "object", "id": "ImportEvaluationsRequestImportOptions" }, "EvaluationRunEvaluationRunSummary": { "properties": { "errorCount": { "readOnly": true, "type": "integer", "description": "Output only. Number of error results for the associated Evaluation in this run.", "format": "int32" }, "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" } }, "description": "Contains the summary of passed and failed result counts for a specific evaluation in an evaluation run.", "id": "EvaluationRunEvaluationRunSummary", "type": "object" }, "EvaluationRun": { "description": "An evaluation run represents an all the evaluation results from an evaluation execution.", "properties": { "goldenRunMethod": { "readOnly": true, "type": "string", "enumDescriptions": [ "Run method is not specified.", "Run the evaluation as stable replay, where each turn is a unique session with the previous expected turns injected as context.", "Run the evaluation as naive replay, where the run is a single session with no context injected." ], "description": "Output only. The method used to run the evaluation.", "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ] }, "appVersionDisplayName": { "description": "Output only. The display name of the `app_version` that the evaluation ran against.", "readOnly": true, "type": "string" }, "changelog": { "readOnly": true, "type": "string", "description": "Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft." }, "latencyReport": { "readOnly": true, "description": "Output only. Latency report for the evaluation run.", "$ref": "LatencyReport" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the evaluation run was created.", "format": "google-datetime" }, "error": { "readOnly": true, "description": "Output only. Deprecated: Use error_info instead. Errors encountered during execution.", "$ref": "Status", "deprecated": true }, "optimizationConfig": { "description": "Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run.", "$ref": "OptimizationConfig" }, "changelogCreateTime": { "readOnly": true, "type": "string", "description": "Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.", "format": "google-datetime" }, "appVersion": { "description": "Output only. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "readOnly": true, "type": "string" }, "evaluationRunSummaries": { "description": "Output only. Map of evaluation name to EvaluationRunSummary.", "additionalProperties": { "$ref": "EvaluationRunEvaluationRunSummary" }, "readOnly": true, "type": "object" }, "evaluationDataset": { "readOnly": true, "type": "string", "description": "Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with `evaluations`. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`" }, "evaluationResults": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. The evaluation results that are part of this run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`" }, "progress": { "description": "Output only. The progress of the evaluation run.", "$ref": "EvaluationRunProgress", "readOnly": true }, "initiatedBy": { "readOnly": true, "type": "string", "description": "Output only. The user who initiated the evaluation run." }, "config": { "description": "Output only. The configuration used in the run.", "$ref": "EvaluationConfig", "readOnly": true }, "personaRunConfigs": { "items": { "$ref": "PersonaRunConfig" }, "readOnly": true, "type": "array", "description": "Output only. The configuration to use for the run per persona." }, "evaluations": { "readOnly": true, "type": "array", "items": { "type": "string" }, "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}`" }, "displayName": { "description": "Optional. User-defined display name of the evaluation run. default: \" run - \".", "type": "string" }, "name": { "description": "Identifier. The unique identifier of the evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`", "type": "string" }, "state": { "description": "Output only. The state of the evaluation run.", "enum": [ "EVALUATION_RUN_STATE_UNSPECIFIED", "RUNNING", "COMPLETED", "ERROR" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Evaluation run state is not specified.", "Evaluation run is running.", "Evaluation run has completed.", "The evaluation run has an error." ] }, "evaluationType": { "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", "description": "Output only. The type of the evaluations in this run.", "enum": [ "EVALUATION_TYPE_UNSPECIFIED", "GOLDEN", "SCENARIO", "MIXED" ] }, "errorInfo": { "description": "Output only. Error information for the evaluation run.", "$ref": "EvaluationErrorInfo", "readOnly": true }, "runCount": { "format": "int32", "description": "Output only. The number of times the evaluations inside the run were run.", "readOnly": true, "type": "integer" }, "scheduledEvaluationRun": { "readOnly": true, "type": "string", "description": "Output only. The scheduled evaluation run resource name that created this evaluation run. This field is only set if the evaluation run was created by a scheduled evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}`" } }, "type": "object", "id": "EvaluationRun" }, "EvaluationScenarioExpectationToolExpectation": { "properties": { "mockToolResponse": { "description": "Required. The tool response to mock, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM.", "$ref": "ToolResponse" }, "expectedToolCall": { "description": "Required. The expected tool call, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM.", "$ref": "ToolCall" } }, "description": "The tool call and response pair to be evaluated.", "id": "EvaluationScenarioExpectationToolExpectation", "type": "object" }, "EvaluationExpectation": { "type": "object", "id": "EvaluationExpectation", "description": "An evaluation expectation represents a specific criteria to evaluate against.", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when the evaluation expectation was created.", "readOnly": true, "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the evaluation expectation was last updated.", "format": "google-datetime" }, "displayName": { "description": "Required. User-defined display name. Must be unique within the app.", "type": "string" }, "llmCriteria": { "description": "Optional. Evaluation criteria based on an LLM prompt.", "$ref": "EvaluationExpectationLlmCriteria" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Optional. User-defined tags for expectations. Can be used to filter expectations." }, "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 this evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`", "type": "string" } } }, "EvaluationResultSemanticSimilarityResult": { "properties": { "score": { "description": "Output only. The semantic similarity score. Can be 0, 1, 2, 3, or 4.", "format": "int32", "readOnly": true, "type": "integer" }, "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" }, "explanation": { "description": "Output only. The explanation for the semantic similarity score.", "readOnly": true, "type": "string" }, "outcome": { "readOnly": true, "type": "string", "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ], "description": "Output only. The outcome of the semantic similarity check. This is determined by comparing the score to the semantic_similarity_success_threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.", "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ] } }, "description": "The result of the semantic similarity check.", "id": "EvaluationResultSemanticSimilarityResult", "type": "object" }, "ListEvaluationResultsResponse": { "description": "Response message for EvaluationService.ListEvaluationResults.", "properties": { "evaluationResults": { "type": "array", "items": { "$ref": "EvaluationResult" }, "description": "The list of evaluation results." }, "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", "id": "ListEvaluationResultsResponse" }, "EvaluationGoldenExpectation": { "description": "Represents a single, checkable requirement.", "properties": { "expectationLevelMetricsThresholdsOverride": { "description": "Optional. Overrides metrics at the step level.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds" }, "agentResponseHallucinationMetricsConfigOverride": { "description": "Optional. Overrides for agent_response hallucination metrics.", "$ref": "EvaluationMetricsConfigHallucinationMetricsConfig" }, "updatedVariables": { "description": "Optional. Check that the agent updated the session variables to the expected values. Used to also capture agent variable updates for golden evals.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "note": { "description": "Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., \"Check_Payment_Tool_Called\".", "type": "string" }, "toolCall": { "description": "Optional. Check that a specific tool was called with the parameters.", "$ref": "ToolCall" }, "toolResponse": { "description": "Optional. Check that a specific tool had the expected response.", "$ref": "ToolResponse" }, "agentTransfer": { "description": "Optional. Check that the agent transferred the conversation to a different agent.", "$ref": "AgentTransfer" }, "skipEvaluation": { "description": "Optional. If set to true, this specific expectation will not be evaluated.", "type": "boolean" }, "agentResponseSemanticSimilarityMetricsConfigOverride": { "description": "Optional. Overrides for agent_response semantic similarity metrics.", "$ref": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig" }, "agentResponse": { "description": "Optional. Check that the agent responded with the correct response. The role \"agent\" is implied.", "$ref": "Message" }, "mockToolResponse": { "description": "Optional. The tool response to mock, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM.", "$ref": "ToolResponse" } }, "type": "object", "id": "EvaluationGoldenExpectation" }, "OpenApiTool": { "id": "OpenApiTool", "type": "object", "properties": { "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" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration.", "$ref": "ServiceDirectoryConfig" }, "ignoreUnknownFields": { "description": "Optional. If true, the agent will ignore unknown fields in the API response.", "type": "boolean" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates that the client will trust.", "$ref": "TlsConfig" }, "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" }, "url": { "description": "Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.", "type": "string" }, "openApiSchema": { "description": "Required. The OpenAPI schema in JSON or YAML format.", "type": "string" }, "apiAuthentication": { "description": "Optional. Authentication information required by the API.", "$ref": "ApiAuthentication" } }, "description": "A remote API tool defined by an OpenAPI schema." }, "Changelog": { "type": "object", "id": "Changelog", "description": "Changelogs represent a change made to the app or to an resource within the app.", "properties": { "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" }, "action": { "readOnly": true, "type": "string", "description": "Output only. The action that was performed on the resource." }, "description": { "readOnly": true, "type": "string", "description": "Output only. Description of the change. which typically captures the changed fields in the resource." }, "newResource": { "readOnly": true, "type": "object", "description": "Output only. The new resource after the change.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "dependentResources": { "readOnly": true, "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "description": "Output only. The dependent resources that were changed." }, "author": { "readOnly": true, "type": "string", "description": "Output only. Email address of the change author." }, "createTime": { "description": "Output only. The time when the change was made.", "format": "google-datetime", "readOnly": true, "type": "string" }, "originalResource": { "description": "Output only. The original resource before the change.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "readOnly": true, "type": "object" }, "sequenceNumber": { "readOnly": true, "type": "string", "format": "int64", "description": "Output only. The monotonically increasing sequence number of the changelog." }, "resource": { "description": "Output only. The resource that was changed.", "readOnly": true, "type": "string" }, "resourceType": { "readOnly": true, "type": "string", "description": "Output only. The type of the resource that was changed." } } }, "ImportAppRequest": { "id": "ImportAppRequest", "type": "object", "properties": { "importOptions": { "description": "Optional. Options governing the import process for the app.", "$ref": "ImportAppRequestImportOptions" }, "ignoreAppLock": { "description": "Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock.", "type": "boolean" }, "appId": { "description": "Optional. The ID to use for the imported app. * If not specified, a unique ID will be automatically assigned for the app. * Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced.", "type": "string" }, "displayName": { "description": "Optional. The display name of the app to import. * If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique. * If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error.", "type": "string" }, "appContent": { "format": "byte", "description": "Raw bytes representing the compressed zip file with the app folder structure.", "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" } }, "description": "Request message for AgentService.ImportApp." }, "ListEvaluationDatasetsResponse": { "description": "Response message for EvaluationService.ListEvaluationDatasets.", "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", "id": "ListEvaluationDatasetsResponse" }, "GenerateAppResourceResponseTools": { "description": "The list of tools generated by the LLM assistant.", "properties": { "tools": { "type": "array", "items": { "$ref": "Tool" }, "description": "The list of tools generated by the LLM assistant." } }, "type": "object", "id": "GenerateAppResourceResponseTools" }, "GoogleSearchSuggestions": { "type": "object", "id": "GoogleSearchSuggestions", "description": "Search suggestions from Google Search Tool.", "properties": { "webSearchQueries": { "items": { "$ref": "WebSearchQuery" }, "type": "array", "description": "List of queries used to perform the google search along with the search result URIs forming the search suggestions." }, "htmls": { "items": { "type": "string" }, "type": "array", "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)`." } } }, "SessionOutputDiagnosticInfo": { "properties": { "rootSpan": { "description": "A trace of the entire request processing, represented as a root span. This span can contain nested child spans for specific operations.", "$ref": "Span" }, "messages": { "description": "List of the messages that happened during the processing.", "items": { "$ref": "Message" }, "type": "array" } }, "description": "Contains execution details during the processing.", "id": "SessionOutputDiagnosticInfo", "type": "object" }, "ExportEvaluationsRequest": { "id": "ExportEvaluationsRequest", "type": "object", "properties": { "includeEvaluations": { "description": "Optional. Includes evaluations in the export. At least one of include_evaluation_results or include_evaluations must be set.", "type": "boolean" }, "includeEvaluationResults": { "description": "Optional. Includes evaluation results in the export. At least one of include_evaluation_results or include_evaluations must be set.", "type": "boolean" }, "exportOptions": { "description": "Optional. The export options for the evaluations.", "$ref": "ExportOptions" }, "names": { "type": "array", "items": { "type": "string" }, "description": "Required. The resource names of the evaluations to export." } }, "description": "Request message for EvaluationService.ExportEvaluations." }, "ToolCall": { "description": "Request for the client or the agent to execute the specified tool.", "properties": { "id": { "description": "Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.", "type": "string" }, "displayName": { "description": "Output only. Display name of the tool.", "readOnly": true, "type": "string" }, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "toolsetTool": { "description": "Optional. The toolset tool to execute.", "$ref": "ToolsetTool" }, "args": { "type": "object", "description": "Optional. The input parameters and values for the tool in JSON object format.", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "type": "object", "id": "ToolCall" }, "ListEvaluationRunsResponse": { "id": "ListEvaluationRunsResponse", "type": "object", "properties": { "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" }, "evaluationRuns": { "description": "The list of evaluation runs.", "items": { "$ref": "EvaluationRun" }, "type": "array" } }, "description": "Response message for EvaluationService.ListEvaluationRuns." }, "ListDeploymentsResponse": { "properties": { "deployments": { "items": { "$ref": "Deployment" }, "type": "array", "description": "The list of deployments." }, "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" } }, "description": "Response message for AgentService.ListDeployments.", "id": "ListDeploymentsResponse", "type": "object" }, "GuardrailModelSafety": { "properties": { "safetySettings": { "type": "array", "items": { "$ref": "GuardrailModelSafetySafetySetting" }, "description": "Required. List of safety settings." } }, "description": "Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe.", "id": "GuardrailModelSafety", "type": "object" }, "GenerateAppResourceResponse": { "description": "Response message for AgentService.GenerateAppResource.", "properties": { "evaluations": { "description": "Evaluations generated by the LLM assistant.", "$ref": "GenerateAppResourceResponseEvaluations" }, "tools": { "description": "The list of tools generated by the LLM assistant.", "$ref": "GenerateAppResourceResponseTools" }, "appSnapshot": { "description": "App snapshot generated by the LLM assistant. This snapshot contains the app, agents & tools generated by the LLM assistant.", "$ref": "AppSnapshot" }, "agent": { "description": "Agent generated by the LLM assistant.", "$ref": "Agent" }, "generateResultInfo": { "description": "Additional information about the generated result.", "$ref": "GenerateAppResourceResponseGenerateResultInfo" }, "qualityReport": { "description": "The quality report generated by the LLM assistant.", "$ref": "QualityReport" }, "toolset": { "description": "Toolset generated by the LLM assistant. Supports Open API toolset schema generation.", "$ref": "Toolset" }, "appResources": { "description": "The app resources generated by the LLM assistant.", "$ref": "GenerateAppResourceResponseAppResources" } }, "type": "object", "id": "GenerateAppResourceResponse" }, "EndUserAuthConfig": { "properties": { "oauth2AuthCodeConfig": { "description": "Oauth 2.0 Authorization Code authentication.", "$ref": "EndUserAuthConfigOauth2AuthCodeConfig" }, "oauth2JwtBearerConfig": { "description": "JWT Profile Oauth 2.0 Authorization Grant authentication.", "$ref": "EndUserAuthConfigOauth2JwtBearerConfig" } }, "description": "End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`.", "id": "EndUserAuthConfig", "type": "object" }, "EvaluationGolden": { "id": "EvaluationGolden", "type": "object", "properties": { "turns": { "type": "array", "items": { "$ref": "EvaluationGoldenTurn" }, "description": "Required. The golden turns required to replay a golden conversation." }, "evaluationExpectations": { "description": "Optional. The evaluation expectations to evaluate the replayed conversation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}`", "type": "array", "items": { "type": "string" } } }, "description": "The steps required to replay a golden conversation." }, "ErrorHandlingSettingsFallbackResponseConfig": { "description": "Configuration for handling fallback responses.", "properties": { "customFallbackMessages": { "type": "object", "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).", "additionalProperties": { "type": "string" } }, "maxFallbackAttempts": { "format": "int32", "description": "Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.", "type": "integer" } }, "type": "object", "id": "ErrorHandlingSettingsFallbackResponseConfig" }, "DataStoreConnectorConfig": { "properties": { "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" }, "collection": { "description": "Resource name of the collection the data store belongs to.", "type": "string" } }, "description": "The connector config for the data store connection.", "id": "DataStoreConnectorConfig", "type": "object" }, "AgentRemoteDialogflowAgent": { "properties": { "flowId": { "description": "Optional. The flow ID of the flow in the Dialogflow agent.", "type": "string" }, "inputVariableMapping": { "type": "object", "description": "Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.", "additionalProperties": { "type": "string" } }, "outputVariableMapping": { "type": "object", "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.", "additionalProperties": { "type": "string" } }, "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" }, "respectResponseInterruptionSettings": { "description": "Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent. * If false: all response messages from the Dialogflow agent follow the app-level barge-in settings. * If true: only response messages with [`allow_playback_interruption`](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#text) set to true will be interruptable, all other messages follow the app-level barge-in settings.", "type": "boolean" } }, "description": "The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent.", "id": "AgentRemoteDialogflowAgent", "type": "object" }, "DataStoreToolBoostSpecs": { "id": "DataStoreToolBoostSpecs", "type": "object", "properties": { "dataStores": { "description": "Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.", "type": "array", "items": { "type": "string" } }, "spec": { "type": "array", "items": { "$ref": "DataStoreToolBoostSpec" }, "description": "Required. A list of boosting specifications." } }, "description": "Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting." }, "FileSearchTool": { "properties": { "description": { "description": "Optional. The tool description.", "type": "string" }, "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" }, "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" } }, "description": "The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results.", "id": "FileSearchTool", "type": "object" }, "ListConversationsResponse": { "description": "Response message for AgentService.ListConversations.", "properties": { "conversations": { "type": "array", "items": { "$ref": "Conversation" }, "description": "The list of conversations." }, "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", "id": "ListConversationsResponse" }, "GenerateAppResourceResponseEvaluations": { "type": "object", "id": "GenerateAppResourceResponseEvaluations", "description": "The list of evaluations generated by the LLM assistant.", "properties": { "evaluations": { "type": "array", "items": { "$ref": "Evaluation" }, "description": "The list of generated evaluations." } } }, "TransferRuleDeterministicTransfer": { "properties": { "pythonCodeCondition": { "description": "Optional. A rule that uses Python code block to evaluate the conditions. If the condition evaluates to true, the transfer occurs.", "$ref": "PythonCodeCondition" }, "expressionCondition": { "description": "Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs.", "$ref": "ExpressionCondition" } }, "description": "Deterministic transfer rule. When the condition evaluates to true, the transfer occurs.", "id": "TransferRuleDeterministicTransfer", "type": "object" }, "RestoreAppVersionRequest": { "description": "Request message for AgentService.RestoreAppVersion", "properties": {}, "type": "object", "id": "RestoreAppVersionRequest" }, "WebSearchQuery": { "properties": { "uri": { "description": "The URI to the Google Search results page for the query.", "type": "string" }, "query": { "description": "The search query text.", "type": "string" } }, "description": "Represents a single web search query and its associated search uri.", "id": "WebSearchQuery", "type": "object" }, "EvaluationResultTaskCompletionResult": { "id": "EvaluationResultTaskCompletionResult", "type": "object", "properties": { "score": { "description": "Output only. The task completion score. Can be -1, 0, 1", "format": "int32", "readOnly": true, "type": "integer" }, "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" }, "explanation": { "readOnly": true, "type": "string", "description": "Output only. The explanation for the task completion score." } }, "description": "The result of the task completion check for the conversation." }, "MockConfig": { "description": "Mock tool calls configuration for the session.", "properties": { "mockedToolCalls": { "type": "array", "items": { "$ref": "MockedToolCall" }, "description": "Optional. All tool calls to mock for the duration of the session." }, "unmatchedToolCallBehavior": { "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Throw an error for any tool calls that don't match a mock expected input pattern.", "For unmatched tool calls, pass the tool call through to real tool." ], "description": "Required. Beavhior for tool calls that don't match any args patterns in mocked_tool_calls.", "enum": [ "UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED", "FAIL", "PASS_THROUGH" ] } }, "type": "object", "id": "MockConfig" }, "ImportEvaluationsResponse": { "description": "Response message for EvaluationService.ImportEvaluations.", "properties": { "evaluationResults": { "items": { "$ref": "EvaluationResult" }, "type": "array", "description": "The list of evaluation results that were imported into the app." }, "evaluationResultImportFailureCount": { "type": "integer", "description": "The number of evaluation results that either failed to import entirely or completed import with one or more errors.", "format": "int32" }, "evaluations": { "items": { "$ref": "Evaluation" }, "type": "array", "description": "The list of evaluations that were imported into the app." }, "evaluationRuns": { "items": { "$ref": "EvaluationRun" }, "type": "array", "description": "The list of evaluation runs that were imported into the app." }, "importFailureCount": { "type": "integer", "description": "The number of evaluations that either failed to import entirely or completed import with one or more errors.", "format": "int32" }, "errorMessages": { "items": { "type": "string" }, "type": "array", "description": "Optional. A list of error messages associated with evaluations that failed to be imported." }, "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" } }, "type": "object", "id": "ImportEvaluationsResponse" }, "EvaluationScenario": { "type": "object", "id": "EvaluationScenario", "description": "The config for a scenario", "properties": { "rubrics": { "description": "Required. The rubrics to score the scenario against.", "items": { "type": "string" }, "type": "array" }, "task": { "description": "Required. The task to be targeted by the scenario.", "type": "string" }, "userGoalBehavior": { "enumDescriptions": [ "Behavior unspecified. Will default to USER_GOAL_SATISFIED.", "The user goal should be completed successfully.", "The user goal should be rejected.", "Ignore the user goal status." ], "description": "Optional. The expected behavior of the user goal.", "enum": [ "USER_GOAL_BEHAVIOR_UNSPECIFIED", "USER_GOAL_SATISFIED", "USER_GOAL_REJECTED", "USER_GOAL_IGNORED" ], "type": "string" }, "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" }, "scenarioExpectations": { "description": "Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation.", "items": { "$ref": "EvaluationScenarioExpectation" }, "type": "array" }, "userFacts": { "items": { "$ref": "EvaluationScenarioUserFact" }, "type": "array", "description": "Optional. The user facts to be used by the scenario." }, "taskCompletionBehavior": { "type": "string", "deprecated": true, "enumDescriptions": [ "Behavior unspecified. Will default to TASK_SATISFIED.", "The user task should be completed successfully.", "The user task should be rejected." ], "description": "Optional. Deprecated. Use user_goal_behavior instead.", "enum": [ "TASK_COMPLETION_BEHAVIOR_UNSPECIFIED", "TASK_SATISFIED", "TASK_REJECTED" ] }, "evaluationExpectations": { "description": "Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}`", "type": "array", "items": { "type": "string" } }, "variableOverrides": { "type": "object", "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.", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "AudioProcessingConfig": { "type": "object", "id": "AudioProcessingConfig", "description": "Configuration for how the input and output audio should be processed and delivered.", "properties": { "ambientSoundConfig": { "description": "Optional. Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.", "$ref": "AmbientSoundConfig" }, "inactivityTimeout": { "type": "string", "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" }, "bargeInConfig": { "description": "Optional. Configures the agent behavior for the user barge-in activities.", "$ref": "BargeInConfig" }, "synthesizeSpeechConfigs": { "description": "Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains \"en-us\" and \"en\", and the specified language code is \"en-gb\", then \"en\" configuration will be used. Note: Language code is case-insensitive.", "additionalProperties": { "$ref": "SynthesizeSpeechConfig" }, "type": "object" } } }, "AppVariableDeclaration": { "id": "AppVariableDeclaration", "type": "object", "properties": { "name": { "description": "Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores.", "type": "string" }, "description": { "description": "Required. The description of the variable.", "type": "string" }, "schema": { "description": "Required. The schema of the variable.", "$ref": "Schema" } }, "description": "Defines the structure and metadata for a variable." }, "RetrieveToolsResponse": { "type": "object", "id": "RetrieveToolsResponse", "description": "Response message for ToolService.RetrieveTools.", "properties": { "tools": { "items": { "$ref": "Tool" }, "type": "array", "description": "The list of tools that are included in the specified toolset." } } }, "GenerateAppResourceResponseGenerateResultInfo": { "type": "object", "id": "GenerateAppResourceResponseGenerateResultInfo", "description": "This provides additional information about the generated result.", "properties": { "explanation": { "description": "An explanation of the changes in the generated resource.", "type": "string" } } }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds": { "properties": { "semanticSimilaritySuccessThreshold": { "type": "integer", "format": "int32", "description": "Optional. The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is \u003e= 3." }, "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" }, "overallToolInvocationCorrectnessThreshold": { "type": "number", "format": "float", "description": "Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0." } }, "description": "Turn level metrics thresholds.", "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds", "type": "object" }, "EvaluationRunProgress": { "properties": { "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" }, "errorCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. Number of evaluation results that failed to execute. (EvaluationResult.execution_state is ERROR)." }, "failedCount": { "readOnly": true, "type": "integer", "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" }, "completedCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. Number of evaluation results that finished successfully. (EvaluationResult.execution_state is COMPLETED)." }, "totalCount": { "readOnly": true, "type": "integer", "description": "Output only. Total number of evaluation results in this run.", "format": "int32" } }, "description": "The progress of the evaluation run.", "id": "EvaluationRunProgress", "type": "object" }, "Location": { "type": "object", "id": "Location", "description": "A resource that represents a Google Cloud location.", "properties": { "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "labels": { "type": "object", "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" } }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "metadata": { "type": "object", "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" } } }, "DataStoreToolEngineSource": { "properties": { "engine": { "description": "Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string" }, "filter": { "description": "Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata", "type": "string" }, "dataStoreSources": { "items": { "$ref": "DataStoreToolDataStoreSource" }, "type": "array", "description": "Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine." } }, "description": "Configuration for searching within an Engine, potentially targeting specific DataStores.", "id": "DataStoreToolEngineSource", "type": "object" }, "MockedToolCall": { "id": "MockedToolCall", "type": "object", "properties": { "expectedArgsPattern": { "type": "object", "description": "Required. A pattern to match against the args / inputs of all dispatched tool calls. If the tool call inputs match this pattern, then mock output will be returned.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "toolset": { "description": "Optional. The toolset to mock.", "$ref": "ToolsetTool" }, "mockResponse": { "description": "Optional. The mock response / output to return if the tool call args / inputs match the pattern.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "toolId": { "description": "Optional. The name of the tool to mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "tool": { "deprecated": true, "description": "Optional. Deprecated. Use tool_identifier instead.", "type": "string" } }, "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." }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "properties": {}, "type": "object", "id": "CancelOperationRequest" }, "AgentLlmAgent": { "type": "object", "id": "AgentLlmAgent", "description": "Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.", "properties": {} }, "ListEvaluationsResponse": { "description": "Response message for EvaluationService.ListEvaluations.", "properties": { "nextPageToken": { "description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" }, "evaluations": { "description": "The list of evaluations.", "type": "array", "items": { "$ref": "Evaluation" } } }, "type": "object", "id": "ListEvaluationsResponse" }, "ToolsetTool": { "description": "A tool that is created from a toolset.", "properties": { "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" }, "toolId": { "description": "Optional. The tool ID to filter the tools to retrieve the schema for.", "type": "string" } }, "type": "object", "id": "ToolsetTool" }, "GuardrailLlmPolicy": { "description": "Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.", "properties": { "maxConversationMessages": { "format": "int32", "description": "Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.", "type": "integer" }, "failOpen": { "description": "Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.", "type": "boolean" }, "policyScope": { "type": "string", "enumDescriptions": [ "Policy scope is not specified.", "Policy check is triggered on user input.", "Policy check is triggered on agent response. Applying this policy scope will introduce additional latency before the agent can respond.", "Policy check is triggered on both user input and agent response. Applying this policy scope will introduce additional latency before the agent can respond." ], "description": "Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond.", "enum": [ "POLICY_SCOPE_UNSPECIFIED", "USER_QUERY", "AGENT_RESPONSE", "USER_QUERY_AND_AGENT_RESPONSE" ] }, "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" }, "modelSettings": { "description": "Optional. Model settings.", "$ref": "ModelSettings" }, "prompt": { "description": "Required. Policy prompt.", "type": "string" } }, "type": "object", "id": "GuardrailLlmPolicy" }, "DataStoreSettingsEngine": { "type": "object", "id": "DataStoreSettingsEngine", "description": "An engine to which the data stores are connected. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.", "properties": { "type": { "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified engine type.", "The SOLUTION_TYPE_SEARCH engine for the app. All connector data stores added to the app will be added to this engine.", "Chat engine type. The SOLUTION_TYPE_CHAT engine for the app. All connector data stores added to the app will be added to this engine." ], "description": "Output only. The type of the engine.", "enum": [ "TYPE_UNSPECIFIED", "ENGINE_TYPE_SEARCH", "ENGINE_TYPE_CHAT" ] }, "name": { "description": "Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "readOnly": true, "type": "string" } } }, "AgentSkill": { "description": "Represents a distinct capability or function that an agent can perform.", "properties": { "description": { "description": "Required. A detailed description of the skill.", "type": "string" }, "outputModes": { "description": "The set of supported output media types for this skill, overriding the agent's defaults.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Required. A unique identifier for the agent's skill.", "type": "string" }, "name": { "description": "Required. A human-readable name for the skill.", "type": "string" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Required. A set of keywords describing the skill's capabilities." }, "examples": { "type": "array", "items": { "type": "string" }, "description": "Example prompts or scenarios that this skill can handle." }, "inputModes": { "items": { "type": "string" }, "type": "array", "description": "The set of supported input media types for this skill, overriding the agent's defaults." } }, "type": "object", "id": "AgentSkill" }, "CodeBlock": { "properties": { "pythonCode": { "description": "Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -\u003e Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -\u003e Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.", "type": "string" } }, "description": "A code block to be executed instead of a real tool call.", "id": "CodeBlock", "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.", "properties": { "createTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the agent was created.", "format": "google-datetime" }, "remoteDialogflowAgent": { "description": "Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.", "$ref": "AgentRemoteDialogflowAgent" }, "beforeAgentCallbacks": { "type": "array", "items": { "$ref": "Callback" }, "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." }, "etag": { "description": "Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.", "type": "string" }, "description": { "description": "Optional. Human-readable description of the agent.", "type": "string" }, "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" }, "transferRules": { "type": "array", "items": { "$ref": "TransferRule" }, "description": "Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used." }, "afterAgentCallbacks": { "description": "Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.", "type": "array", "items": { "$ref": "Callback" } }, "guardrails": { "items": { "type": "string" }, "type": "array", "description": "Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`" }, "modelSettings": { "description": "Optional. Configurations for the LLM model.", "$ref": "ModelSettings" }, "validationErrors": { "description": "Output only. Misconfigurations or errors in the agent that may affect agent quality.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when the agent was last updated.", "readOnly": true, "type": "string" }, "afterModelCallbacks": { "description": "Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.", "type": "array", "items": { "$ref": "Callback" } }, "beforeToolCallbacks": { "items": { "$ref": "Callback" }, "type": "array", "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." }, "beforeModelCallbacks": { "items": { "$ref": "Callback" }, "type": "array", "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." }, "toolsets": { "type": "array", "items": { "$ref": "AgentAgentToolset" }, "description": "Optional. List of toolsets for the agent." }, "tools": { "description": "Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "array", "items": { "type": "string" } }, "displayName": { "description": "Required. Display name of the agent.", "type": "string" }, "afterToolCallbacks": { "type": "array", "items": { "$ref": "Callback" }, "description": "Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped." }, "generatedSummary": { "readOnly": true, "type": "string", "description": "Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation." }, "name": { "description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "llmAgent": { "description": "Optional. The default agent type.", "$ref": "AgentLlmAgent" }, "instruction": { "description": "Optional. Instructions for the LLM model to guide the agent's behavior.", "type": "string" } }, "type": "object", "id": "Agent" }, "BargeInConfig": { "type": "object", "id": "BargeInConfig", "description": "Configuration for how the user barge-in activities should be handled.", "properties": { "disableBargeIn": { "description": "Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile.", "deprecated": true, "type": "boolean" }, "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" } } }, "Image": { "description": "Represents an image input or output in the conversation.", "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp", "type": "string" }, "data": { "description": "Required. Raw bytes of the image.", "format": "byte", "type": "string" } }, "type": "object", "id": "Image" }, "GenerateAppResourceRequestAppGenerationConfig": { "properties": { "datasetId": { "description": "Optional. The insights dataset to be used to fetch conversation data for generating the agents & tools. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.", "type": "string" }, "gcsLocation": { "description": "Optional. The Cloud Storage location to store the generated question answer data to be used by the Datastore tool. This data is generated only when using conversation data as an input source. The location must be in the same project as the app. Format: `gs://...`.", "type": "string" }, "context": { "description": "Optional. The context which describes the requirements of the agents & tools to be generated.", "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" }, "fileContexts": { "description": "Optional. The files to be used as context.", "items": { "$ref": "FileContext" }, "type": "array" } }, "description": "The configuration to be used to generate the app.", "id": "GenerateAppResourceRequestAppGenerationConfig", "type": "object" }, "ListOperationsResponse": { "id": "ListOperationsResponse", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "type": "array", "items": { "type": "string" }, "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." } }, "description": "The response message for Operations.ListOperations." }, "DataStoreToolBoostSpec": { "type": "object", "id": "DataStoreToolBoostSpec", "description": "Boost specification to boost certain documents.", "properties": { "conditionBoostSpecs": { "items": { "$ref": "DataStoreToolBoostSpecConditionBoostSpec" }, "type": "array", "description": "Required. A list of boosting specifications." } } }, "ExportEvaluationResultsResponse": { "description": "Response message for EvaluationService.ExportEvaluationResults.", "properties": { "evaluationResultsContent": { "format": "byte", "description": "The content of the exported Evaluation Results. This will be populated if gcs_uri was not specified in the request.", "type": "string" }, "evaluationResultsUri": { "description": "The Google Cloud Storage URI folder where the exported Evaluation Results were written. This will be populated if gcs_uri was specified in the request.", "type": "string" } }, "type": "object", "id": "ExportEvaluationResultsResponse" }, "Event": { "description": "Event input.", "properties": { "event": { "description": "Required. The name of the event.", "type": "string" } }, "type": "object", "id": "Event" }, "Tool": { "type": "object", "id": "Tool", "description": "A tool represents an action that the CES agent can take to achieve certain goals.", "properties": { "remoteAgentTool": { "description": "Optional. The remote agent tool.", "$ref": "RemoteAgentTool" }, "systemTool": { "description": "Optional. The system tool.", "$ref": "SystemTool" }, "pythonFunction": { "description": "Optional. The python function tool.", "$ref": "PythonFunction" }, "googleSearchTool": { "description": "Optional. The google search tool.", "$ref": "GoogleSearchTool" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the tool was created.", "format": "google-datetime" }, "connectorTool": { "description": "Optional. The Integration Connector tool.", "$ref": "ConnectorTool" }, "toolFakeConfig": { "description": "Optional. Configuration for tool behavior in fake mode.", "$ref": "ToolFakeConfig" }, "fileSearchTool": { "description": "Optional. The file search tool.", "$ref": "FileSearchTool" }, "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" }, "clientFunction": { "description": "Optional. The client function.", "$ref": "ClientFunction" }, "mcpTool": { "description": "Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.", "$ref": "McpTool" }, "dataStoreTool": { "description": "Optional. The data store tool.", "$ref": "DataStoreTool" }, "widgetTool": { "description": "Optional. The widget tool.", "$ref": "WidgetTool" }, "executionType": { "type": "string", "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." ] }, "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": { "description": "Optional. The open API tool.", "$ref": "OpenApiTool" }, "displayName": { "readOnly": true, "type": "string", "description": "Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its `name` property." }, "generatedSummary": { "description": "Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.", "readOnly": true, "type": "string" }, "agentTool": { "description": "Optional. The agent tool.", "$ref": "AgentTool" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when the tool was last updated." }, "timeout": { "format": "google-duration", "description": "Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools.", "type": "string" } } }, "AgentCard": { "id": "AgentCard", "type": "object", "properties": { "description": { "description": "Required. A description of the agent's domain of action/solution space.", "type": "string" }, "version": { "description": "Required. The version of the agent.", "type": "string" }, "supportedInterfaces": { "description": "Required. Ordered list of supported interfaces. The first entry is preferred.", "type": "array", "items": { "$ref": "AgentInterface" } }, "skills": { "items": { "$ref": "AgentSkill" }, "type": "array", "description": "Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at." }, "name": { "description": "Required. A human-readable name for the agent.", "type": "string" } }, "description": "AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard" }, "AggregatedMetricsSemanticSimilarityMetrics": { "type": "object", "id": "AggregatedMetricsSemanticSimilarityMetrics", "description": "Metrics for semantic similarity results.", "properties": { "score": { "readOnly": true, "type": "number", "format": "float", "description": "Output only. The average semantic similarity score (0-4)." } } }, "EvaluationMetricsConfigToolCorrectnessMetricsConfig": { "description": "Configuration for correctness metrics for the evaluation. To disable the metric, set the message but do not set the `enable_tool_correctness_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", "properties": { "enableToolCorrectnessMetrics": { "description": "Optional. Whether to calculate tool correctness metrics for the evaluation.", "type": "boolean" } }, "type": "object", "id": "EvaluationMetricsConfigToolCorrectnessMetricsConfig" }, "GenerateAppResourceResponseAppResources": { "properties": { "appSnapshot": { "description": "The app snapshot generated by the LLM assistant. This snapshot contains the app, agents & tools generated by the LLM assistant.", "$ref": "AppSnapshot" }, "evaluations": { "description": "The list of evaluations generated by the LLM assistant.", "type": "array", "items": { "$ref": "Evaluation" } } }, "description": "The list of app resources generated by the LLM assistant.", "id": "GenerateAppResourceResponseAppResources", "type": "object" }, "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" } }, "description": "Configuration for default system security settings.", "id": "GuardrailLlmPromptSecurityDefaultSecuritySettings", "type": "object" }, "EvaluationResultOverallToolInvocationResult": { "properties": { "outcome": { "readOnly": true, "type": "string", "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ], "description": "Output only. The outcome of the tool invocation check. This is determined by comparing the tool_invocation_score to the overall_tool_invocation_correctness_threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.", "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ] }, "toolInvocationScore": { "format": "float", "description": "The overall tool invocation score for this turn. This indicates the overall percent of tools from the expected turn that were actually invoked.", "type": "number" } }, "description": "The result of the overall tool invocation check.", "id": "EvaluationResultOverallToolInvocationResult", "type": "object" }, "TlsConfig": { "properties": { "caCerts": { "items": { "$ref": "TlsConfigCaCert" }, "type": "array", "description": "Required. Specifies a list of allowed custom CA certificates for HTTPS verification." } }, "description": "The TLS configuration.", "id": "TlsConfig", "type": "object" }, "LatencyReportLatencyMetrics": { "properties": { "p50Latency": { "readOnly": true, "type": "string", "description": "Output only. The 50th percentile latency.", "format": "google-duration" }, "callCount": { "readOnly": true, "type": "integer", "description": "Output only. The number of times the resource was called.", "format": "int32" }, "p90Latency": { "readOnly": true, "type": "string", "format": "google-duration", "description": "Output only. The 90th percentile latency." }, "p99Latency": { "readOnly": true, "type": "string", "format": "google-duration", "description": "Output only. The 99th percentile latency." } }, "description": "Latency metrics for a component.", "id": "LatencyReportLatencyMetrics", "type": "object" }, "EvaluationErrorInfo": { "type": "object", "id": "EvaluationErrorInfo", "description": "Information about an error encountered during an evaluation execution.", "properties": { "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" ], "readOnly": true, "type": "string", "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." ] }, "sessionId": { "description": "Output only. The session ID for the conversation that caused the error.", "readOnly": true, "type": "string" }, "errorMessage": { "readOnly": true, "type": "string", "description": "Output only. The error message." } } }, "QualityReport": { "type": "object", "id": "QualityReport", "description": "The report describing any identified quality issues in the app.", "properties": { "issues": { "description": "Optional. The issues grouped by agent.", "items": { "$ref": "QualityReportAgentIssues" }, "type": "array" }, "generalIssues": { "description": "Optional. General issues not specific to any agent.", "items": { "$ref": "QualityReportIssue" }, "type": "array" }, "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" } } }, "ListToolsResponse": { "id": "ListToolsResponse", "type": "object", "properties": { "tools": { "items": { "$ref": "Tool" }, "type": "array", "description": "The list of tools." }, "nextPageToken": { "description": "A token that can be sent as ListToolsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } }, "description": "Response message for AgentService.ListTools." }, "GenerateAppResourceRequestEvaluationGenerationConfig": { "id": "GenerateAppResourceRequestEvaluationGenerationConfig", "type": "object", "properties": { "datasetId": { "description": "Optional. The insights dataset to be used to fetch conversation data for generating the evaluations. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.", "type": "string" } }, "description": "The configuration to be used to generate the evaluations." }, "GenerateEvaluationRequest": { "id": "GenerateEvaluationRequest", "type": "object", "properties": { "source": { "description": "Optional. Indicate the source of the conversation. If not set, all sources will be searched.", "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "type": "string", "deprecated": true, "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ] } }, "description": "Request message for EvaluationService.GenerateEvaluation." }, "GoogleSearchTool": { "type": "object", "id": "GoogleSearchTool", "description": "Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.", "properties": { "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.", "type": "array", "items": { "type": "string" } }, "promptConfig": { "description": "Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.", "$ref": "GoogleSearchToolPromptConfig" }, "contextUrls": { "items": { "type": "string" }, "type": "array", "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." }, "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.", "type": "array", "items": { "type": "string" } } } }, "AppSnapshot": { "id": "AppSnapshot", "type": "object", "properties": { "examples": { "description": "Optional. List of examples in the app.", "type": "array", "items": { "$ref": "Example" } }, "guardrails": { "description": "Optional. List of guardrails in the app.", "items": { "$ref": "Guardrail" }, "type": "array" }, "agents": { "description": "Optional. List of agents in the app.", "type": "array", "items": { "$ref": "Agent" } }, "app": { "description": "Optional. The basic settings for the app.", "$ref": "App" }, "toolsets": { "description": "Optional. List of toolsets in the app.", "type": "array", "items": { "$ref": "Toolset" } }, "tools": { "items": { "$ref": "Tool" }, "type": "array", "description": "Optional. List of tools in the app." } }, "description": "A snapshot of the app." }, "OpenApiToolset": { "type": "object", "id": "OpenApiToolset", "description": "A toolset that contains a list of tools that are defined by an OpenAPI schema.", "properties": { "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration.", "$ref": "ServiceDirectoryConfig" }, "ignoreUnknownFields": { "description": "Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.", "type": "boolean" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates", "$ref": "TlsConfig" }, "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" }, "openApiSchema": { "description": "Required. The OpenAPI schema of the toolset.", "type": "string" }, "apiAuthentication": { "description": "Optional. Authentication information required by the API.", "$ref": "ApiAuthentication" } } }, "LatencyReportToolLatency": { "properties": { "toolsetTool": { "readOnly": true, "description": "Output only. The toolset tool identifier.", "$ref": "ToolsetTool" }, "latencyMetrics": { "description": "Output only. The latency metrics for the tool.", "$ref": "LatencyReportLatencyMetrics", "readOnly": true }, "toolDisplayName": { "readOnly": true, "type": "string", "description": "Output only. The display name of the tool." }, "tool": { "readOnly": true, "type": "string", "description": "Output only. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`." } }, "description": "Latency metrics for a single tool.", "id": "LatencyReportToolLatency", "type": "object" }, "ErrorHandlingSettingsEndSessionConfig": { "type": "object", "id": "ErrorHandlingSettingsEndSessionConfig", "description": "Configuration for ending the session in case of system errors (e.g. LLM errors).", "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" } } }, "QualityReportAgentIssues": { "description": "Issues identified for a single agent.", "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", "id": "QualityReportAgentIssues" }, "EvaluationResultUserGoalSatisfactionResult": { "description": "The result of a user goal satisfaction check for a conversation.", "properties": { "score": { "readOnly": true, "type": "integer", "description": "Output only. The user task satisfaction score. Can be -1, 0, 1.", "format": "int32" }, "label": { "readOnly": true, "type": "string", "description": "Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified" }, "explanation": { "readOnly": true, "type": "string", "description": "Output only. The explanation for the user task satisfaction score." } }, "type": "object", "id": "EvaluationResultUserGoalSatisfactionResult" }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds": { "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds", "type": "object", "properties": { "turnLevelMetricsThresholds": { "description": "Optional. The turn level metrics thresholds.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds" }, "expectationLevelMetricsThresholds": { "description": "Optional. The expectation level metrics thresholds.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds" }, "toolMatchingSettings": { "description": "Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.", "$ref": "EvaluationMetricsThresholdsToolMatchingSettings" } }, "description": "Settings for golden evaluations." }, "ApiAuthentication": { "type": "object", "id": "ApiAuthentication", "description": "Authentication information required for API calls.", "properties": { "bearerTokenConfig": { "description": "Optional. Config for bearer token auth.", "$ref": "BearerTokenConfig" }, "oauthConfig": { "description": "Optional. Config for OAuth.", "$ref": "OAuthConfig" }, "serviceAgentIdTokenAuthConfig": { "description": "Optional. Config for ID token auth generated from CES service agent.", "$ref": "ServiceAgentIdTokenAuthConfig" }, "serviceAccountAuthConfig": { "description": "Optional. Config for service account authentication.", "$ref": "ServiceAccountAuthConfig" }, "apiKeyConfig": { "description": "Optional. Config for API key auth.", "$ref": "ApiKeyConfig" } } }, "Action": { "id": "Action", "type": "object", "properties": { "connectionActionId": { "description": "ID of a Connection action for the tool to use.", "type": "string" }, "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" }, "entityOperation": { "description": "Entity operation configuration for the tool to use.", "$ref": "ActionEntityOperation" }, "outputFields": { "description": "Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.", "items": { "type": "string" }, "type": "array" } }, "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." }, "RemoteAgentTool": { "type": "object", "id": "RemoteAgentTool", "description": "Represents a tool that allows the agent to call another remote agent.", "properties": { "description": { "description": "Required. The description of the tool.", "type": "string" }, "agentCard": { "description": "Required. The agent card of the remote agent that this tool invokes.", "$ref": "AgentCard" }, "name": { "description": "Required. The name of the tool.", "type": "string" } } }, "EvaluationResultGoldenExpectationOutcomeToolInvocationResult": { "properties": { "parameterCorrectnessScore": { "format": "float", "description": "Output only. The tool invocation parameter correctness score. This indicates the percent of parameters from the expected tool call that were also present in the actual tool call.", "readOnly": true, "type": "number" }, "outcome": { "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", "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" ] }, "explanation": { "description": "Output only. A free text explanation for the tool invocation result.", "readOnly": true, "type": "string" } }, "description": "The result of the tool invocation check.", "id": "EvaluationResultGoldenExpectationOutcomeToolInvocationResult", "type": "object" }, "App": { "id": "App", "type": "object", "properties": { "evaluationMetricsThresholds": { "description": "Optional. The evaluation thresholds for the app.", "$ref": "EvaluationMetricsThresholds" }, "vpcScSettings": { "description": "Optional. VPC-SC settings for the app.", "$ref": "VpcScSettings" }, "variableDeclarations": { "items": { "$ref": "AppVariableDeclaration" }, "type": "array", "description": "Optional. The declarations of the variables." }, "languageSettings": { "description": "Optional. Language settings of the app.", "$ref": "LanguageSettings" }, "description": { "description": "Optional. Human-readable description of the app.", "type": "string" }, "validationErrors": { "description": "Output only. Misconfigurations or warnings in the app.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "guardrails": { "description": "Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "type": "array", "items": { "type": "string" } }, "modelSettings": { "description": "Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.", "$ref": "ModelSettings" }, "predefinedVariableDeclarations": { "description": "Output only. The declarations of predefined variables for the app.", "items": { "$ref": "AppVariableDeclaration" }, "readOnly": true, "type": "array" }, "loggingSettings": { "description": "Optional. Logging settings of the app.", "$ref": "LoggingSettings" }, "metadata": { "description": "Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.", "additionalProperties": { "type": "string" }, "type": "object" }, "defaultChannelProfile": { "description": "Optional. The default channel profile used by the app.", "$ref": "ChannelProfile" }, "evaluationPersonas": { "type": "array", "items": { "$ref": "EvaluationPersona" }, "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." }, "name": { "description": "Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string" }, "evaluationSettings": { "description": "Optional. The evaluation settings for the app.", "$ref": "EvaluationSettings" }, "timeZoneSettings": { "description": "Optional. TimeZone settings of the app.", "$ref": "TimeZoneSettings" }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when the app was last updated.", "readOnly": true, "type": "string" }, "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" }, "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" }, "errorHandlingSettings": { "description": "Optional. Error handling settings of the app.", "$ref": "ErrorHandlingSettings" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when the app was created." }, "etag": { "readOnly": true, "type": "string", "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." }, "clientCertificateSettings": { "description": "Optional. The default client certificate settings for the app.", "$ref": "ClientCertificateSettings" }, "pinned": { "description": "Optional. Whether the app is pinned in the app list.", "type": "boolean" }, "deploymentCount": { "format": "int32", "description": "Output only. Number of deployments in the app.", "readOnly": true, "type": "integer" }, "audioProcessingConfig": { "description": "Optional. Audio processing configuration of the app.", "$ref": "AudioProcessingConfig" }, "dataStoreSettings": { "description": "Optional. The data store settings for the app.", "$ref": "DataStoreSettings" }, "displayName": { "description": "Required. Display name of the app.", "type": "string" }, "rootAgent": { "description": "Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "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" } }, "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." }, "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" } }, "description": "Pre-defined system tool.", "id": "SystemTool", "type": "object" }, "QualityReportIssue": { "properties": { "description": { "description": "Optional. Description of the issue found.", "type": "string" }, "occurrenceCount": { "format": "int32", "description": "Optional. How many times this issue occurred.", "type": "integer" }, "proposedSolution": { "description": "Optional. Proposed solution to fix the issue by modifying instructions or tools.", "type": "string" } }, "description": "The issue identified.", "id": "QualityReportIssue", "type": "object" }, "EndUserAuthConfigOauth2JwtBearerConfig": { "description": "JWT Profile Oauth 2.0 Authorization Grant authentication configuration.", "properties": { "issuer": { "description": "Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" }, "clientKey": { "description": "Required. Client parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" }, "subject": { "description": "Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" } }, "type": "object", "id": "EndUserAuthConfigOauth2JwtBearerConfig" }, "LatencyReportGuardrailLatency": { "type": "object", "id": "LatencyReportGuardrailLatency", "description": "Latency metrics for a single guardrail.", "properties": { "latencyMetrics": { "readOnly": true, "description": "Output only. The latency metrics for the guardrail.", "$ref": "LatencyReportLatencyMetrics" }, "guardrailDisplayName": { "description": "Output only. The display name of the guardrail.", "readOnly": true, "type": "string" }, "guardrail": { "readOnly": true, "type": "string", "description": "Output only. The name of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`." } } }, "AgentTool": { "id": "AgentTool", "type": "object", "properties": { "name": { "description": "Required. The name of the agent tool.", "type": "string" }, "agent": { "description": "Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", "type": "string" }, "rootAgent": { "type": "string", "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}`" }, "description": { "description": "Optional. Description of the tool's purpose.", "type": "string" } }, "description": "Represents a tool that allows the agent to call another agent." }, "EvaluationResultScenarioExpectationOutcomeObservedToolCall": { "properties": { "toolCall": { "description": "Output only. The observed tool call.", "$ref": "ToolCall", "readOnly": true }, "toolResponse": { "description": "Output only. The observed tool response.", "$ref": "ToolResponse", "readOnly": true } }, "description": "The observed tool call and response.", "id": "EvaluationResultScenarioExpectationOutcomeObservedToolCall", "type": "object" }, "EndpointControlPolicy": { "id": "EndpointControlPolicy", "type": "object", "properties": { "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" }, "allowedOrigins": { "description": "Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, \"https://example.com\" will match \"https://example.com:443\" and any other port. \"https://example.com:443\" will only match \"https://example.com:443\".", "type": "array", "items": { "type": "string" } } }, "description": "Defines project/location level endpoint control policy." }, "EvaluationResultGoldenResult": { "type": "object", "id": "EvaluationResultGoldenResult", "description": "The result of a golden evaluation.", "properties": { "turnReplayResults": { "items": { "$ref": "EvaluationResultGoldenResultTurnReplayResult" }, "readOnly": true, "type": "array", "description": "Output only. The result of running each turn of the golden conversation." }, "evaluationExpectationResults": { "readOnly": true, "type": "array", "items": { "$ref": "EvaluationResultEvaluationExpectationResult" }, "description": "Output only. The results of the evaluation expectations." } } }, "BatchDeleteConversationsResponse": { "id": "BatchDeleteConversationsResponse", "type": "object", "properties": { "failedConversations": { "description": "The list of conversations that failed to be deleted.", "items": { "type": "string" }, "type": "array" }, "errorMessages": { "items": { "type": "string" }, "type": "array", "description": "Optional. A list of error messages associated with conversations that failed to be deleted." }, "deletedConversations": { "description": "The list of conversations that were successfully deleted.", "type": "array", "items": { "type": "string" } } }, "description": "Response message for AgentService.BatchDeleteConversations." }, "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" } }, "description": "OutputAudioConfig configures how the CES agent should synthesize outgoing audio responses.", "id": "OutputAudioConfig", "type": "object" }, "RunEvaluationRequest": { "properties": { "appVersion": { "description": "Optional. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "runCount": { "type": "integer", "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" }, "optimizationConfig": { "description": "Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run.", "$ref": "OptimizationConfig" }, "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" }, "config": { "description": "Optional. The configuration to use for the run.", "$ref": "EvaluationConfig" }, "personaRunConfigs": { "items": { "$ref": "PersonaRunConfig" }, "type": "array", "description": "Optional. The configuration to use for the run per persona." }, "generateLatencyReport": { "description": "Optional. Whether to generate a latency report for the evaluation run.", "type": "boolean" }, "evaluations": { "items": { "type": "string" }, "type": "array", "description": "Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`" }, "app": { "description": "Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string" }, "evaluationDataset": { "description": "Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "type": "string" }, "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" }, "displayName": { "description": "Optional. The display name of the evaluation run.", "type": "string" } }, "description": "Request message for EvaluationService.RunEvaluation.", "id": "RunEvaluationRequest", "type": "object" }, "Operation": { "id": "Operation", "type": "object", "properties": { "response": { "type": "object", "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`.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "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" }, "metadata": { "type": "object", "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.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" } }, "description": "This resource represents a long-running operation that is the result of a network API call." }, "ConversationTurn": { "description": "All information about a single turn in the conversation.", "properties": { "messages": { "items": { "$ref": "Message" }, "type": "array", "description": "Optional. List of messages in the conversation turn, including user input, agent responses and intermediate events during the processing." }, "rootSpan": { "description": "Optional. The root span of the action processing.", "$ref": "Span" } }, "type": "object", "id": "ConversationTurn" }, "ChannelProfileWebWidgetConfigSecuritySettings": { "description": "Security settings for the web widget.", "properties": { "enablePublicAccess": { "description": "Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.", "type": "boolean" }, "allowedOrigins": { "items": { "type": "string" }, "type": "array", "description": "Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: \"https://example.com\"" }, "enableOriginCheck": { "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" }, "enableRecaptcha": { "description": "Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.", "type": "boolean" } }, "type": "object", "id": "ChannelProfileWebWidgetConfigSecuritySettings" }, "EvaluationResultSpanLatency": { "type": "object", "id": "EvaluationResultSpanLatency", "description": "The latency of a span execution.", "properties": { "resource": { "readOnly": true, "type": "string", "description": "Output only. The resource name of the guardrail or tool spans." }, "type": { "enumDescriptions": [ "Default value. This value is unused.", "Tool call span.", "User callback span.", "Guardrail span.", "LLM span." ], "readOnly": true, "type": "string", "description": "Output only. The type of span.", "enum": [ "TYPE_UNSPECIFIED", "TOOL", "USER_CALLBACK", "GUARDRAIL", "LLM" ] }, "callback": { "readOnly": true, "type": "string", "description": "Output only. The name of the user callback span." }, "toolset": { "readOnly": true, "description": "Output only. The toolset tool identifier.", "$ref": "ToolsetTool" }, "executionLatency": { "readOnly": true, "type": "string", "format": "google-duration", "description": "Output only. The latency of span." }, "model": { "description": "Output only. The name of the LLM span.", "readOnly": true, "type": "string" }, "endTime": { "format": "google-datetime", "description": "Output only. The end time of span.", "readOnly": true, "type": "string" }, "startTime": { "readOnly": true, "type": "string", "description": "Output only. The start time of span.", "format": "google-datetime" }, "displayName": { "description": "Output only. The display name of the span. Applicable to tool and guardrail spans.", "readOnly": true, "type": "string" } } }, "AggregatedMetrics": { "type": "object", "id": "AggregatedMetrics", "description": "Aggregated metrics for an evaluation or evaluation dataset.", "properties": { "metricsByAppVersion": { "description": "Output only. Aggregated metrics, grouped by app version ID.", "items": { "$ref": "AggregatedMetricsMetricsByAppVersion" }, "readOnly": true, "type": "array" } } }, "SessionOutput": { "properties": { "citations": { "description": "Citations that provide the source information for the agent's generated text.", "$ref": "Citations" }, "endSession": { "description": "Indicates the session has ended.", "$ref": "EndSession" }, "payload": { "description": "Custom payload with structured output from the CES agent.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "turnCompleted": { "description": "If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn.", "type": "boolean" }, "audio": { "type": "string", "description": "Output audio from the CES agent.", "format": "byte" }, "toolCalls": { "description": "Request for the client to execute the tools.", "$ref": "ToolCalls" }, "googleSearchSuggestions": { "description": "The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.", "$ref": "GoogleSearchSuggestions" }, "turnIndex": { "type": "integer", "format": "int32", "description": "Indicates the sequential order of conversation turn to which this output belongs to, starting from 1." }, "text": { "description": "Output text from the CES agent.", "type": "string" }, "diagnosticInfo": { "description": "Optional. Diagnostic information contains execution details during the processing of the input. Only populated in the last SessionOutput (with `turn_completed=true`) for each turn.", "$ref": "SessionOutputDiagnosticInfo" } }, "description": "Output for the session.", "id": "SessionOutput", "type": "object" }, "Citations": { "properties": { "citedChunks": { "description": "List of cited pieces of information.", "type": "array", "items": { "$ref": "CitationsCitedChunk" } } }, "description": "Citations associated with the agent response.", "id": "Citations", "type": "object" }, "EvaluationPersona": { "type": "object", "id": "EvaluationPersona", "description": "A persona represents an end user in an evaluation.", "properties": { "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" }, "displayName": { "description": "Required. The display name of the persona. Unique within an app.", "type": "string" }, "speechConfig": { "description": "Optional. Configuration for how the persona sounds (TTS settings).", "$ref": "EvaluationPersonaSpeechConfig" }, "description": { "description": "Optional. The description of the persona.", "type": "string" } } }, "DataStoreToolSummarizationConfig": { "id": "DataStoreToolSummarizationConfig", "type": "object", "properties": { "disabled": { "description": "Optional. Whether summarization is disabled.", "type": "boolean" }, "prompt": { "description": "Optional. The prompt definition. If not set, default prompt will be used.", "type": "string" }, "modelSettings": { "description": "Optional. Configurations for the LLM model.", "$ref": "ModelSettings" } }, "description": "Summarization configuration." }, "GenerateAppResourceRequestHillClimbingFixConfig": { "description": "The configuration to be used for hill climbing fixes.", "properties": { "qualityReport": { "description": "Required. The quality report used to inform the instruction following fix.", "$ref": "QualityReport" } }, "type": "object", "id": "GenerateAppResourceRequestHillClimbingFixConfig" }, "AggregatedMetricsToolMetrics": { "id": "AggregatedMetricsToolMetrics", "type": "object", "properties": { "failCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The number of times the tool failed." }, "tool": { "description": "Output only. The name of the tool.", "readOnly": true, "type": "string" }, "passCount": { "description": "Output only. The number of times the tool passed.", "format": "int32", "readOnly": true, "type": "integer" } }, "description": "Metrics for a single tool." }, "TriggerActionGenerativeAnswer": { "type": "object", "id": "TriggerActionGenerativeAnswer", "description": "The agent will immediately respond with a generative answer.", "properties": { "prompt": { "description": "Required. The prompt to use for the generative answer.", "type": "string" } } }, "WidgetTool": { "id": "WidgetTool", "type": "object", "properties": { "parameters": { "description": "Optional. The input parameters of the widget tool.", "$ref": "Schema" }, "description": { "description": "Optional. The description of the widget tool.", "type": "string" }, "textResponseConfig": { "description": "Optional. Configuration for always-included text responses.", "$ref": "WidgetToolTextResponseConfig" }, "name": { "description": "Required. The display name of the widget tool.", "type": "string" }, "uiConfig": { "type": "object", "description": "Optional. Configuration for rendering the widget.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "dataMapping": { "description": "Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.", "$ref": "WidgetToolDataMapping" }, "widgetType": { "type": "string", "enumDescriptions": [ "Unspecified widget type.", "Custom widget type.", "Product carousel widget.", "Product details widget.", "Quick actions widget.", "Product comparison widget.", "Advanced product details widget.", "Short form widget.", "Overall satisfaction widget.", "Order summary widget.", "Appointment details widget.", "Appointment scheduler widget.", "Contact form widget." ], "description": "Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.", "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" ] } }, "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." }, "PersonaRunConfig": { "properties": { "taskCount": { "format": "int32", "description": "Optional. The number of tasks to run for the persona.", "type": "integer" }, "persona": { "description": "Optional. The persona to use for the evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`", "type": "string" } }, "description": "Configuration for running an evaluation for a specific persona.", "id": "PersonaRunConfig", "type": "object" }, "ClientCertificateSettings": { "properties": { "tlsCertificate": { "description": "Required. The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.", "type": "string" }, "passphrase": { "description": "Optional. The name of the SecretManager secret version resource storing the passphrase to decrypt the private key. Should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`", "type": "string" }, "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" } }, "description": "Settings for custom client certificates.", "id": "ClientCertificateSettings", "type": "object" }, "EvaluationResultToolCallLatency": { "id": "EvaluationResultToolCallLatency", "type": "object", "properties": { "startTime": { "description": "Output only. The start time of the tool call execution.", "format": "google-datetime", "readOnly": true, "type": "string" }, "tool": { "readOnly": true, "type": "string", "description": "Output only. The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`." }, "endTime": { "description": "Output only. The end time of the tool call execution.", "format": "google-datetime", "readOnly": true, "type": "string" }, "executionLatency": { "readOnly": true, "type": "string", "description": "Output only. The latency of the tool call execution.", "format": "google-duration" }, "displayName": { "readOnly": true, "type": "string", "description": "Output only. The display name of the tool." } }, "description": "The latency of a tool call execution." }, "UploadEvaluationAudioResponse": { "properties": { "duration": { "description": "The duration of the audio.", "format": "google-duration", "type": "string" }, "audioGcsUri": { "description": "The Google Cloud Storage URI where the uploaded audio file is stored. Format: `gs:///`", "type": "string" }, "transcript": { "description": "The transcript of the audio, generated by Cloud Speech-to-Text.", "type": "string" } }, "description": "Response message for EvaluationService.UploadEvaluationAudio.", "id": "UploadEvaluationAudioResponse", "type": "object" }, "ImportEvaluationsRequest": { "type": "object", "id": "ImportEvaluationsRequest", "description": "Request message for EvaluationService.ImportEvaluations.", "properties": { "csvContent": { "format": "byte", "description": "Raw bytes representing the csv file with the evaluations structure.", "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": { "description": "Optional. Options governing the import process for the evaluations.", "$ref": "ImportEvaluationsRequestImportOptions" }, "conversationList": { "description": "The conversations to import the evaluations from.", "$ref": "ImportEvaluationsRequestConversationList" } } }, "AmbientSoundConfig": { "properties": { "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": { "type": "number", "format": "double", "description": "Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that." }, "prebuiltAmbientNoise": { "deprecated": true, "enumDescriptions": [ "Not specified.", "Ambient noise of a retail store.", "Ambient noise of a convention hall.", "Ambient noise of a street." ], "type": "string", "description": "Optional. Deprecated: `prebuilt_ambient_noise` is deprecated in favor of `prebuilt_ambient_sound`.", "enum": [ "PREBUILT_AMBIENT_NOISE_UNSPECIFIED", "RETAIL_STORE", "CONVENTION_HALL", "OUTDOOR" ] }, "gcsUri": { "description": "Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in [Cloud Storage](https://cloud.google.com/storage). Note: Please make sure the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object.", "type": "string" } }, "description": "Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.", "id": "AmbientSoundConfig", "type": "object" }, "AggregatedMetricsHallucinationMetrics": { "description": "Metrics for hallucination results.", "properties": { "score": { "readOnly": true, "type": "number", "description": "Output only. The average hallucination score (0 to 1).", "format": "float" } }, "type": "object", "id": "AggregatedMetricsHallucinationMetrics" }, "ExportAppResponse": { "type": "object", "id": "ExportAppResponse", "description": "Response message for AgentService.ExportApp.", "properties": { "appContent": { "format": "byte", "description": "App folder compressed as a zip file.", "type": "string" }, "appUri": { "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which the app was exported.", "type": "string" } } }, "Schema": { "description": "Represents a select subset of an OpenAPI 3.0 schema object.", "properties": { "additionalProperties": { "description": "Optional. Can either be a boolean or an object, controls the presence of additional properties.", "$ref": "Schema" }, "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" }, "maxItems": { "description": "Optional. Maximum number of the elements for Type.ARRAY.", "format": "int64", "type": "string" }, "required": { "description": "Optional. Required properties of Type.OBJECT.", "items": { "type": "string" }, "type": "array" }, "nullable": { "description": "Optional. Indicates if the value may be null.", "type": "boolean" }, "prefixItems": { "description": "Optional. Schemas of initial elements of Type.ARRAY.", "type": "array", "items": { "$ref": "Schema" } }, "anyOf": { "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", "items": { "$ref": "Schema" }, "type": "array" }, "type": { "enumDescriptions": [ "Type unspecified.", "String type.", "Integer type.", "Number type.", "Boolean type.", "Object type.", "Array type." ], "description": "Required. The type of the data.", "enum": [ "TYPE_UNSPECIFIED", "STRING", "INTEGER", "NUMBER", "BOOLEAN", "OBJECT", "ARRAY" ], "type": "string" }, "description": { "description": "Optional. The description of the data.", "type": "string" }, "uniqueItems": { "description": "Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.", "type": "boolean" }, "defs": { "description": "Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.", "additionalProperties": { "$ref": "Schema" }, "type": "object" }, "items": { "description": "Optional. Schema of the elements of Type.ARRAY.", "$ref": "Schema" }, "title": { "description": "Optional. The title of the schema.", "type": "string" }, "minimum": { "type": "number", "format": "double", "description": "Optional. Minimum value for Type.INTEGER and Type.NUMBER." }, "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" }, "properties": { "description": "Optional. Properties of Type.OBJECT.", "additionalProperties": { "$ref": "Schema" }, "type": "object" }, "default": { "description": "Optional. Default value of the data.", "type": "any" }, "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" } }, "type": "object", "id": "Schema" }, "TriggerActionTransferAgent": { "description": "The agent will transfer the conversation to a different agent.", "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", "id": "TriggerActionTransferAgent" }, "EvaluationMetricsConfigUserGoalMetMetricsConfig": { "description": "Configuration for the user goal met metrics for the evaluation. To disable the metric, set the message but do not set the `enable_user_goal_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", "properties": { "enableUserGoalMetMetrics": { "description": "Optional. Whether to calculate the user goal met metrics for the evaluation.", "type": "boolean" } }, "type": "object", "id": "EvaluationMetricsConfigUserGoalMetMetricsConfig" }, "BearerTokenConfig": { "type": "object", "id": "BearerTokenConfig", "description": "Configurations for authentication with a bearer token.", "properties": { "token": { "description": "Required. The bearer token. Must be in the format `$context.variables.`.", "type": "string" } } }, "EvaluationStep": { "description": "A step defines a singular action to happen during the evaluation.", "properties": { "agentTransfer": { "description": "Optional. Transfer the conversation to a different agent.", "$ref": "AgentTransfer" }, "userInput": { "description": "Optional. User input for the conversation.", "$ref": "SessionInput" }, "expectation": { "description": "Optional. Executes an expectation on the current turn.", "$ref": "EvaluationGoldenExpectation" } }, "type": "object", "id": "EvaluationStep" }, "AppVersion": { "id": "AppVersion", "type": "object", "properties": { "displayName": { "description": "Optional. The display name of the app version.", "type": "string" }, "snapshot": { "description": "Output only. The snapshot of the app when the version is created.", "$ref": "AppSnapshot", "readOnly": true }, "name": { "description": "Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "creator": { "description": "Output only. Email of the user who created the app version.", "readOnly": true, "type": "string" }, "etag": { "readOnly": true, "type": "string", "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." }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the app version was created.", "format": "google-datetime" }, "description": { "description": "Optional. The description of the app version.", "type": "string" } }, "description": "In Customer Engagement Suite (CES), an app version is a snapshot of the app at a specific point in time. It is immutable and cannot be modified once created." }, "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" } }, "description": "Represents the persona property of a channel.", "id": "ChannelProfilePersonaProperty", "type": "object" }, "LatencyReportCallbackLatency": { "id": "LatencyReportCallbackLatency", "type": "object", "properties": { "stage": { "description": "Output only. The stage of the callback.", "readOnly": true, "type": "string" }, "latencyMetrics": { "description": "Output only. The latency metrics for the callback.", "$ref": "LatencyReportLatencyMetrics", "readOnly": true } }, "description": "Latency metrics for a single callback." }, "SessionInput": { "type": "object", "id": "SessionInput", "description": "Input for the session.", "properties": { "dtmf": { "description": "Optional. DTMF digits from the end user.", "type": "string" }, "blob": { "description": "Optional. Blob data from the end user.", "$ref": "Blob" }, "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" }, "text": { "description": "Optional. Text data from the end user.", "type": "string" }, "image": { "description": "Optional. Image data from the end user.", "$ref": "Image" }, "audio": { "type": "string", "description": "Optional. Audio data from the end user.", "format": "byte" }, "variables": { "type": "object", "description": "Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "toolResponses": { "description": "Optional. Execution results for the tool calls from the client.", "$ref": "ToolResponses" }, "event": { "description": "Optional. Event input.", "$ref": "Event" } } }, "ListChangelogsResponse": { "type": "object", "id": "ListChangelogsResponse", "description": "Response message for AgentService.ListChangelogs.", "properties": { "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" }, "changelogs": { "type": "array", "items": { "$ref": "Changelog" }, "description": "The list of changelogs." } } }, "EvaluationResultScenarioRubricOutcome": { "type": "object", "id": "EvaluationResultScenarioRubricOutcome", "description": "The outcome of the evaluation against the rubric.", "properties": { "score": { "description": "Output only. The score of the conversation against the rubric.", "format": "float", "readOnly": true, "type": "number" }, "rubric": { "readOnly": true, "type": "string", "description": "Output only. The rubric that was used to evaluate the conversation." }, "scoreExplanation": { "readOnly": true, "type": "string", "description": "Output only. The rater's response to the rubric." } } }, "EndUserAuthConfigOauth2AuthCodeConfig": { "type": "object", "id": "EndUserAuthConfigOauth2AuthCodeConfig", "description": "Oauth 2.0 Authorization Code authentication configuration.", "properties": { "oauthToken": { "description": "Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" } } }, "ExecuteToolRequest": { "id": "ExecuteToolRequest", "type": "object", "properties": { "toolsetTool": { "description": "Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.", "$ref": "ToolsetTool" }, "args": { "description": "Optional. The input parameters and values for the tool in JSON object format.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "tool": { "description": "Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}", "type": "string" }, "mockConfig": { "description": "Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.", "$ref": "MockConfig" }, "context": { "type": "object", "description": "Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "variables": { "description": "Optional. The variables that are available for the tool execution.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "description": "Request message for ToolService.ExecuteTool." }, "ToolCalls": { "type": "object", "id": "ToolCalls", "description": "Request for the client to execute the tools and return the execution results before continuing the session.", "properties": { "toolCalls": { "description": "Optional. The list of tool calls to execute.", "items": { "$ref": "ToolCall" }, "type": "array" } } }, "Guardrail": { "id": "Guardrail", "type": "object", "properties": { "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when the guardrail was last updated.", "readOnly": true, "type": "string" }, "llmPromptSecurity": { "description": "Optional. Guardrail that blocks the conversation if the prompt is considered unsafe based on the LLM classification.", "$ref": "GuardrailLlmPromptSecurity" }, "modelSafety": { "description": "Optional. Guardrail that blocks the conversation if the LLM response is considered unsafe based on the model safety settings.", "$ref": "GuardrailModelSafety" }, "codeCallback": { "description": "Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution.", "$ref": "GuardrailCodeCallback" }, "name": { "description": "Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "type": "string" }, "displayName": { "description": "Required. Display name of the guardrail.", "type": "string" }, "enabled": { "description": "Optional. Whether the guardrail is enabled.", "type": "boolean" }, "llmPolicy": { "description": "Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.", "$ref": "GuardrailLlmPolicy" }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when the guardrail was created.", "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" }, "contentFilter": { "description": "Optional. Guardrail that bans certain content from being used in the conversation.", "$ref": "GuardrailContentFilter" }, "description": { "description": "Optional. Description of the guardrail.", "type": "string" }, "action": { "description": "Optional. Action to take when the guardrail is triggered.", "$ref": "TriggerAction" } }, "description": "Guardrail contains a list of checks and balances to keep the agents safe and secure." }, "TriggerActionRespondImmediately": { "type": "object", "id": "TriggerActionRespondImmediately", "description": "The agent will immediately respond with a preconfigured response.", "properties": { "responses": { "items": { "$ref": "TriggerActionResponse" }, "type": "array", "description": "Required. The canned responses for the agent to choose from. The response is chosen randomly." } } }, "ApiKeyConfig": { "type": "object", "id": "ApiKeyConfig", "description": "Configurations for authentication with API key.", "properties": { "requestLocation": { "enumDescriptions": [ "Unspecified. This value should not be used.", "Represents the key in http header.", "Represents the key in query string." ], "description": "Required. Key location in the request.", "enum": [ "REQUEST_LOCATION_UNSPECIFIED", "HEADER", "QUERY_STRING" ], "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" }, "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" } } }, "GuardrailCodeCallback": { "type": "object", "id": "GuardrailCodeCallback", "description": "Guardrail that blocks the conversation based on the code callbacks provided.", "properties": { "beforeAgentCallback": { "description": "Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.", "$ref": "Callback" }, "afterModelCallback": { "description": "Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.", "$ref": "Callback" }, "afterAgentCallback": { "description": "Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.", "$ref": "Callback" }, "beforeModelCallback": { "description": "Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.", "$ref": "Callback" } } }, "GuardrailLlmPromptSecurity": { "description": "Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification.", "properties": { "failOpen": { "description": "Optional. Determines the behavior when the guardrail encounters an LLM error. - If true: the guardrail is bypassed. - If false (default): the guardrail triggers/blocks. Note: If a custom policy is provided, this field is ignored in favor of the policy's 'fail_open' configuration.", "type": "boolean" }, "customPolicy": { "description": "Optional. Use a user-defined LlmPolicy to configure the security guardrail.", "$ref": "GuardrailLlmPolicy" }, "defaultSettings": { "description": "Optional. Use the system's predefined default security settings. To select this mode, include an empty 'default_settings' message in the request. The 'default_prompt_template' field within will be populated by the server in the response.", "$ref": "GuardrailLlmPromptSecurityDefaultSecuritySettings" } }, "type": "object", "id": "GuardrailLlmPromptSecurity" }, "InputAudioConfig": { "type": "object", "id": "InputAudioConfig", "description": "InputAudioConfig configures how the CES agent should interpret the incoming audio data.", "properties": { "audioEncoding": { "enumDescriptions": [ "Unspecified audio encoding.", "16-bit linear PCM audio encoding.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law." ], "description": "Required. The encoding of the input audio data.", "enum": [ "AUDIO_ENCODING_UNSPECIFIED", "LINEAR16", "MULAW", "ALAW" ], "type": "string" }, "sampleRateHertz": { "format": "int32", "description": "Required. The sample rate (in Hertz) of the input audio data.", "type": "integer" }, "noiseSuppressionLevel": { "description": "Optional. Whether to enable noise suppression on the input audio. Available values are \"low\", \"moderate\", \"high\", \"very_high\".", "type": "string" } } }, "EvaluationResultHallucinationResult": { "description": "The result of the hallucination check for a single turn.", "properties": { "score": { "format": "int32", "description": "Output only. The hallucination score. Can be -1, 0, 1.", "readOnly": true, "type": "integer" }, "label": { "readOnly": true, "type": "string", "description": "Output only. The label associated with each score. Score 1: Justified Score 0: Not Justified Score -1: No Claim To Assess" }, "explanation": { "readOnly": true, "type": "string", "description": "Output only. The explanation for the hallucination score." } }, "type": "object", "id": "EvaluationResultHallucinationResult" }, "MetricAnalysisSettings": { "properties": { "llmMetricsOptedOut": { "description": "Optional. Whether to collect conversation data for llm analysis metrics. If true, conversation data will not be collected for llm analysis metrics; otherwise, conversation data will be collected.", "type": "boolean" } }, "description": "Settings to describe the conversation data collection behaviors for LLM analysis metrics pipeline.", "id": "MetricAnalysisSettings", "type": "object" }, "ExportEvaluationResultsRequest": { "description": "Request message for EvaluationService.ExportEvaluationResults.", "properties": { "names": { "description": "Required. The resource names of the evaluation results to export.", "type": "array", "items": { "type": "string" } }, "exportOptions": { "description": "Optional. The export options for the evaluation results.", "$ref": "ExportOptions" } }, "type": "object", "id": "ExportEvaluationResultsRequest" }, "DataStoreToolGroundingConfig": { "properties": { "disabled": { "description": "Optional. Whether grounding is disabled.", "type": "boolean" }, "groundingLevel": { "type": "number", "format": "float", "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." } }, "description": "Grounding configuration.", "id": "DataStoreToolGroundingConfig", "type": "object" }, "ChannelProfileWebWidgetConfig": { "description": "Message for configuration for the web widget.", "properties": { "webWidgetTitle": { "description": "Optional. The title of the web widget.", "type": "string" }, "securitySettings": { "description": "Optional. The security settings of the web widget.", "$ref": "ChannelProfileWebWidgetConfigSecuritySettings" }, "modality": { "type": "string", "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." ] }, "theme": { "description": "Optional. The theme of the web widget.", "enum": [ "THEME_UNSPECIFIED", "LIGHT", "DARK" ], "enumDescriptions": [ "Unknown theme.", "Light theme.", "Dark theme." ], "type": "string" } }, "type": "object", "id": "ChannelProfileWebWidgetConfig" }, "ExportAppRequest": { "properties": { "exportFormat": { "enumDescriptions": [ "The export format is unspecified.", "The export format is JSON.", "The export format is YAML." ], "description": "Required. The format to export the app in.", "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "JSON", "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" }, "appVersion": { "description": "Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`.", "type": "string" } }, "description": "Request message for AgentService.ExportApp.", "id": "ExportAppRequest", "type": "object" }, "EvaluationDataset": { "description": "An evaluation dataset represents a set of evaluations that are grouped together basaed on shared tags.", "properties": { "lastUpdatedBy": { "description": "Output only. The user who last updated the evaluation dataset.", "readOnly": true, "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" }, "createTime": { "description": "Output only. Timestamp when the evaluation dataset was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when the evaluation dataset was last updated." }, "displayName": { "description": "Required. User-defined display name of the evaluation dataset. Unique within an App.", "type": "string" }, "name": { "description": "Identifier. The unique identifier of this evaluation dataset. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "type": "string" }, "aggregatedMetrics": { "description": "Output only. The aggregated metrics for this evaluation dataset across all runs.", "$ref": "AggregatedMetrics", "readOnly": true }, "evaluations": { "items": { "type": "string" }, "type": "array", "description": "Optional. Evaluations that are included in this dataset." }, "createdBy": { "readOnly": true, "type": "string", "description": "Output only. The user who created the evaluation dataset." } }, "type": "object", "id": "EvaluationDataset" }, "RunSessionRequest": { "properties": { "config": { "description": "Required. The configuration for the session.", "$ref": "SessionConfig" }, "inputs": { "description": "Required. Inputs for the session.", "items": { "$ref": "SessionInput" }, "type": "array" } }, "description": "Request message for SessionService.RunSession.", "id": "RunSessionRequest", "type": "object" }, "AgentTransfer": { "description": "Represents an event indicating the transfer of a conversation to a different agent.", "properties": { "targetAgent": { "description": "Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "displayName": { "description": "Output only. Display name of the agent.", "readOnly": true, "type": "string" } }, "type": "object", "id": "AgentTransfer" }, "AgentInterface": { "id": "AgentInterface", "type": "object", "properties": { "tenant": { "description": "Tenant ID to be used in the request when calling the agent.", "type": "string" }, "protocolVersion": { "description": "Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: \"0.3\", \"1.0\"", "type": "string" }, "protocolBinding": { "description": "Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.", "type": "string" }, "url": { "description": "Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: \"https://api.example.com/a2a/v1\", \"https://grpc.example.com/a2a\"", "type": "string" } }, "description": "Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms." }, "ChannelProfile": { "id": "ChannelProfile", "type": "object", "properties": { "channelType": { "enumDescriptions": [ "Unknown channel type.", "Web UI channel.", "API channel.", "Twilio channel.", "Google Telephony Platform channel.", "Contact Center as a Service (CCaaS) channel.", "Five9 channel.", "Third party contact center integration channel." ], "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" ], "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" }, "personaProperty": { "description": "Optional. The persona property of the channel profile.", "$ref": "ChannelProfilePersonaProperty" }, "disableDtmf": { "description": "Optional. Whether to disable DTMF (dual-tone multi-frequency).", "type": "boolean" }, "webWidgetConfig": { "description": "Optional. The configuration for the web widget.", "$ref": "ChannelProfileWebWidgetConfig" }, "noiseSuppressionLevel": { "description": "Optional. The noise suppression level of the channel profile. Available values are \"low\", \"moderate\", \"high\", \"very_high\".", "type": "string" }, "profileId": { "description": "Optional. The unique identifier of the channel profile.", "type": "string" } }, "description": "A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony." }, "LatencyReportLlmCallLatency": { "properties": { "model": { "description": "Output only. The name of the model.", "readOnly": true, "type": "string" }, "latencyMetrics": { "description": "Output only. The latency metrics for the LLM call.", "$ref": "LatencyReportLatencyMetrics", "readOnly": true } }, "description": "Latency metrics for a single LLM call.", "id": "LatencyReportLlmCallLatency", "type": "object" }, "EvaluationSettings": { "properties": { "metricsConfig": { "description": "Optional. Configures the default metrics for evaluations.", "$ref": "EvaluationMetricsConfig" }, "goldenRunMethod": { "enumDescriptions": [ "Run method is not specified.", "Run the evaluation as stable replay, where each turn is a unique session with the previous expected turns injected as context.", "Run the evaluation as naive replay, where the run is a single session with no context injected." ], "description": "Optional. The 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" ], "type": "string" }, "goldenEvaluationToolCallBehaviour": { "type": "string", "enumDescriptions": [ "Unspecified tool call behavior. Will default to real tool calls.", "Use real tool calls.", "Use fake tool calls." ], "description": "Optional. Configures the default tool call behaviour for golden evaluations.", "enum": [ "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED", "REAL", "FAKE" ] }, "scenarioConversationInitiator": { "type": "string", "enumDescriptions": [ "Unspecified. Defaults to USER.", "The user starts the conversation.", "The agent starts the conversation." ], "description": "Optional. Who starts the conversation in a scenario evaluation.", "enum": [ "SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED", "USER", "AGENT" ] }, "scenarioEvaluationToolCallBehaviour": { "enumDescriptions": [ "Unspecified tool call behavior. Will default to real tool calls.", "Use real tool calls.", "Use fake tool calls." ], "description": "Optional. Configures the default tool call behaviour for scenario evaluations.", "enum": [ "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED", "REAL", "FAKE" ], "type": "string" } }, "description": "Settings for evaluation.", "id": "EvaluationSettings", "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.", "properties": { "channelProfile": { "description": "Required. The channel profile used in the deployment.", "$ref": "ChannelProfile" }, "createTime": { "description": "Output only. Timestamp when this deployment was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when this deployment was last updated.", "readOnly": true, "type": "string" }, "displayName": { "description": "Required. Display name of the deployment.", "type": "string" }, "appVersion": { "description": "Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.", "type": "string" }, "etag": { "readOnly": true, "type": "string", "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." }, "experimentConfig": { "description": "Optional. Experiment configuration for the deployment.", "$ref": "ExperimentConfig" }, "name": { "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" } }, "type": "object", "id": "Deployment" }, "DataStoreToolBoostSpecConditionBoostSpec": { "properties": { "boostControlSpec": { "description": "Optional. Complex specification for custom ranking based on customer defined attribute value.", "$ref": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec" }, "condition": { "description": "Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY(\"en\", \"fr\"))", "type": "string" }, "boost": { "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.", "format": "float", "type": "number" } }, "description": "Boost specification for a condition.", "id": "DataStoreToolBoostSpecConditionBoostSpec", "type": "object" }, "EvaluationResultEvaluationExpectationResult": { "id": "EvaluationResultEvaluationExpectationResult", "type": "object", "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": { "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", "description": "Output only. The outcome of the evaluation expectation.", "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ] }, "prompt": { "description": "Output only. The prompt that was used for the evaluation.", "readOnly": true, "type": "string" } }, "description": "The result of a single evaluation expectation." }, "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": { "type": "string", "enumDescriptions": [ "Unspecified harm block threshold.", "Block low threshold and above (i.e. block more).", "Block medium threshold and above.", "Block only high threshold (i.e. block less).", "Block none.", "Turn off the safety filter." ], "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" ] } }, "description": "Safety setting.", "id": "GuardrailModelSafetySafetySetting", "type": "object" }, "RetrieveToolSchemaRequest": { "description": "Request message for ToolService.RetrieveToolSchema.", "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": { "description": "Optional. The toolset tool to retrieve the schema for. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.", "$ref": "ToolsetTool" } }, "type": "object", "id": "RetrieveToolSchemaRequest" }, "GenerateEvaluationOperationMetadata": { "type": "object", "id": "GenerateEvaluationOperationMetadata", "description": "Operation metadata for EvaluationService.GenerateEvaluation.", "properties": {} }, "ToolResponses": { "id": "ToolResponses", "type": "object", "properties": { "toolResponses": { "description": "Optional. The list of tool execution results.", "type": "array", "items": { "$ref": "ToolResponse" } } }, "description": "Execution results for the requested tool calls from the client." }, "DataStoreSettings": { "properties": { "engines": { "description": "Output only. The engines for the app.", "readOnly": true, "type": "array", "items": { "$ref": "DataStoreSettingsEngine" } } }, "description": "Data store related settings for the app.", "id": "DataStoreSettings", "type": "object" }, "Chunk": { "type": "object", "id": "Chunk", "description": "A chunk of content within a message.", "properties": { "defaultVariables": { "type": "object", "description": "A struct represents default variables at the start of the conversation, keyed by variable names.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "updatedVariables": { "type": "object", "description": "A struct represents variables that were updated in the conversation, keyed by variable names.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "payload": { "type": "object", "description": "Optional. Custom payload data.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "image": { "description": "Optional. Image data.", "$ref": "Image" }, "blob": { "description": "Optional. Blob data.", "$ref": "Blob" }, "agentTransfer": { "description": "Optional. Agent transfer event.", "$ref": "AgentTransfer" }, "text": { "description": "Optional. Text data.", "type": "string" }, "toolCall": { "description": "Optional. Tool execution request.", "$ref": "ToolCall" }, "toolResponse": { "description": "Optional. Tool execution response.", "$ref": "ToolResponse" }, "transcript": { "description": "Optional. Transcript associated with the audio.", "type": "string" } } }, "ExpressionCondition": { "properties": { "expression": { "description": "Required. The string representation of cloud.api.Expression condition.", "type": "string" } }, "description": "Expression condition based on session state.", "id": "ExpressionCondition", "type": "object" }, "ListScheduledEvaluationRunsResponse": { "properties": { "scheduledEvaluationRuns": { "description": "The list of scheduled evaluation runs.", "items": { "$ref": "ScheduledEvaluationRun" }, "type": "array" }, "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" } }, "description": "Response message for EvaluationService.ListScheduledEvaluationRuns.", "id": "ListScheduledEvaluationRunsResponse", "type": "object" }, "Toolset": { "type": "object", "id": "Toolset", "description": "A toolset represents a group of dynamically managed tools that can be used by the agent.", "properties": { "name": { "description": "Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string" }, "displayName": { "description": "Optional. The display name of the toolset. Must be unique within the same app.", "type": "string" }, "connectorToolset": { "description": "Optional. A toolset that generates tools from an Integration Connectors Connection.", "$ref": "ConnectorToolset" }, "description": { "description": "Optional. The description of the toolset.", "type": "string" }, "openApiToolset": { "description": "Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema.", "$ref": "OpenApiToolset" }, "executionType": { "type": "string", "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." ] }, "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" }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the toolset was last updated.", "format": "google-datetime" }, "mcpToolset": { "description": "Optional. A toolset that contains a list of tools that are offered by the MCP server.", "$ref": "McpToolset" }, "toolFakeConfig": { "description": "Optional. Configuration for tools behavior in fake mode.", "$ref": "ToolFakeConfig" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the toolset was created.", "format": "google-datetime" } } }, "DataStore": { "id": "DataStore", "type": "object", "properties": { "displayName": { "description": "Output only. The display name of the data store.", "readOnly": true, "type": "string" }, "name": { "description": "Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", "type": "string" }, "type": { "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", "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" ] }, "createTime": { "description": "Output only. Timestamp when the data store was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "connectorConfig": { "description": "Output only. The connector config for the data store connection.", "$ref": "DataStoreConnectorConfig", "readOnly": true }, "documentProcessingMode": { "readOnly": true, "type": "string", "enumDescriptions": [ "Not specified.", "Documents are processed as documents.", "Documents are converted to chunks." ], "description": "Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.", "enum": [ "DOCUMENT_PROCESSING_MODE_UNSPECIFIED", "DOCUMENTS", "CHUNKS" ] } }, "description": "A DataStore resource in Vertex AI Search." }, "GenerateAppResourceRequestToolGenerationConfig": { "properties": { "fileContexts": { "items": { "$ref": "FileContext" }, "type": "array", "description": "Optional. The files to be used as context." }, "openApiToolsetGenerationConfig": { "description": "Optional. The configuration to be used to generate an Open API schema.", "$ref": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig" }, "context": { "description": "Optional. The context which describes the tool to be generated. This can be empty if the tool request & response are provided.", "type": "string" } }, "description": "The configuration to be used to generate a tool.", "id": "GenerateAppResourceRequestToolGenerationConfig", "type": "object" }, "Status": { "properties": { "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." } }, "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", "type": "object" }, "Conversation": { "description": "A conversation represents an interaction between an end user and the CES app.", "properties": { "messages": { "description": "Deprecated. Use turns instead.", "deprecated": true, "type": "array", "items": { "$ref": "Message" } }, "channelType": { "description": "DEPRECATED. Please use input_types instead.", "enum": [ "CHANNEL_TYPE_UNSPECIFIED", "TEXT", "AUDIO", "MULTIMODAL" ], "deprecated": true, "enumDescriptions": [ "Unspecified channel type.", "The conversation only contains text messages between the end user and the agent.", "The conversation contains audio messages between the end user and the agent.", "The conversation multi-modal messages (e.g. image) between the end user and the agent." ], "type": "string" }, "entryAgent": { "readOnly": true, "type": "string", "description": "Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`" }, "endTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the conversation was completed.", "format": "google-datetime" }, "name": { "description": "Identifier. The unique identifier of the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`", "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" }, "turns": { "type": "array", "items": { "$ref": "ConversationTurn" }, "description": "Required. The turns in the conversation." }, "turnCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The number of turns in the conversation." }, "inputTypes": { "items": { "enumDescriptions": [ "Unspecified input type.", "Text input.", "Event input.", "Audio input.", "Image input.", "Blob input.", "Client function tool response input.", "Variables input." ], "enum": [ "INPUT_TYPE_UNSPECIFIED", "INPUT_TYPE_TEXT", "INPUT_TYPE_EVENT", "INPUT_TYPE_AUDIO", "INPUT_TYPE_IMAGE", "INPUT_TYPE_BLOB", "INPUT_TYPE_TOOL_RESPONSE", "INPUT_TYPE_VARIABLES" ], "type": "string" }, "readOnly": true, "type": "array", "description": "Output only. The input types of the conversation." }, "appVersion": { "readOnly": true, "type": "string", "description": "Output only. The version of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`" }, "startTime": { "format": "google-datetime", "description": "Output only. Timestamp when the conversation was created.", "readOnly": true, "type": "string" }, "languageCode": { "description": "Output only. The language code of the conversation.", "readOnly": true, "type": "string" }, "source": { "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "readOnly": true, "type": "string", "description": "Output only. Indicate the source of the conversation.", "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ] } }, "type": "object", "id": "Conversation" }, "AudioRecordingConfig": { "description": "Configuration for how the audio interactions should be recorded.", "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", "id": "AudioRecordingConfig" }, "Evaluation": { "id": "Evaluation", "type": "object", "properties": { "lastUpdatedBy": { "readOnly": true, "type": "string", "description": "Output only. The user who last updated the evaluation." }, "scenario": { "description": "Optional. The config for a scenario.", "$ref": "EvaluationScenario" }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when the evaluation was last updated.", "readOnly": true, "type": "string" }, "name": { "description": "Identifier. The unique identifier of this evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "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" }, "displayName": { "description": "Required. User-defined display name of the evaluation. Unique within an App.", "type": "string" }, "invalid": { "readOnly": true, "type": "boolean", "description": "Output only. Whether the evaluation is invalid. This can happen if an evaluation is referencing a tool, toolset, or agent that has since been deleted." }, "lastCompletedResult": { "readOnly": true, "description": "Output only. The latest evaluation result for this evaluation.", "$ref": "EvaluationResult" }, "etag": { "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.", "readOnly": true, "type": "string" }, "tags": { "description": "Optional. User defined tags to categorize the evaluation.", "type": "array", "items": { "type": "string" } }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when the evaluation was created.", "readOnly": true, "type": "string" }, "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" }, "aggregatedMetrics": { "description": "Output only. The aggregated metrics for this evaluation across all runs.", "$ref": "AggregatedMetrics", "readOnly": true }, "golden": { "description": "Optional. The golden steps to be evaluated.", "$ref": "EvaluationGolden" }, "createdBy": { "readOnly": true, "type": "string", "description": "Output only. The user who created the evaluation." }, "evaluationRuns": { "description": "Output only. The EvaluationRuns that this Evaluation is associated with.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "evaluationMetricsConfigOverride": { "description": "Optional. Overrides metrics config for this specific evaluation.", "$ref": "EvaluationMetricsConfig" }, "description": { "description": "Optional. User-defined description of the evaluation.", "type": "string" }, "evaluationMetricsThresholdOverride": { "description": "Optional. Overrides metrics thresholds for this specific evaluation.", "$ref": "EvaluationMetricsThresholds" } }, "description": "An evaluation represents all of the information needed to simulate and evaluate an agent." }, "WidgetToolDataMapping": { "properties": { "mode": { "type": "string", "enumDescriptions": [ "Unspecified mode.", "Use the `field_mappings` map for data transformation.", "Use the `python_script` for data transformation." ], "description": "Optional. The mode of the data mapping.", "enum": [ "MODE_UNSPECIFIED", "FIELD_MAPPING", "PYTHON_SCRIPT" ] }, "fieldMappings": { "type": "object", "description": "Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.", "additionalProperties": { "type": "string" } }, "pythonFunction": { "description": "Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.", "$ref": "PythonFunction" }, "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" }, "pythonScript": { "type": "string", "deprecated": true, "description": "Deprecated: Use `python_function` instead." } }, "description": "Configuration for mapping data from a source tool to the widget's input parameters.", "id": "WidgetToolDataMapping", "type": "object" }, "VpcScSettings": { "properties": { "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "Optional. The allowed HTTP(s) origins that OpenAPI tools in the App are able to directly call when VPC Service Controls are enabled. These strings must match the origin exactly, including the port if specified. For example, \"https://example.com\" or \"https://example.com:443\". This list does not yet apply to Python tools that may make direct HTTP calls." } }, "description": "VPC-SC settings for the app.", "id": "VpcScSettings", "type": "object" }, "SessionConfig": { "type": "object", "id": "SessionConfig", "description": "The configuration for the session.", "properties": { "timeZone": { "description": "Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. \"America/Los_Angeles\".", "type": "string" }, "inputAudioConfig": { "description": "Optional. Configuration for processing the input audio.", "$ref": "InputAudioConfig" }, "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" }, "remoteDialogflowQueryParameters": { "description": "Optional. [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters) to send to the remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent when the session control is transferred to the remote agent.", "$ref": "SessionConfigRemoteDialogflowQueryParameters" }, "outputAudioConfig": { "description": "Optional. Configuration for generating the output audio.", "$ref": "OutputAudioConfig" }, "historicalContexts": { "description": "Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.", "type": "array", "items": { "$ref": "Message" } }, "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" }, "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" }, "deployment": { "description": "Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" } } }, "BatchDeleteConversationsRequest": { "type": "object", "id": "BatchDeleteConversationsRequest", "description": "Request message for AgentService.BatchDeleteConversations.", "properties": { "conversations": { "type": "array", "items": { "type": "string" }, "description": "Required. The resource names of the conversations to delete." } } }, "EvaluationGoldenTurn": { "description": "A golden turn defines a single turn in a golden conversation.", "properties": { "steps": { "description": "Required. The steps required to replay a golden conversation.", "items": { "$ref": "EvaluationStep" }, "type": "array" }, "rootSpan": { "description": "Optional. The root span of the golden turn for processing and maintaining audio information. The uri for the audio must contain audio saved in 16Khz sample rate.", "$ref": "Span" }, "turnLevelMetricsThresholdsOverride": { "description": "Optional. Overrides for turn-level metric thresholds.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds" }, "hallucinationMetricBehaviorOverride": { "type": "string", "description": "Optional. Override for turn-level hallucination metric behavior.", "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ] } }, "type": "object", "id": "EvaluationGoldenTurn" }, "CloudLoggingSettings": { "properties": { "enableCloudLogging": { "description": "Optional. Whether to enable Cloud Logging for the sessions.", "type": "boolean" } }, "description": "Settings to describe the Cloud Logging behaviors for the app.", "id": "CloudLoggingSettings", "type": "object" }, "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec": { "properties": { "fieldName": { "description": "Optional. The name of the field whose value will be used to determine the boost amount.", "type": "string" }, "attributeType": { "enumDescriptions": [ "Unspecified AttributeType.", "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. E.g. `5D`, `3DT12H30M`, `T24H`." ], "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", "enum": [ "ATTRIBUTE_TYPE_UNSPECIFIED", "NUMERICAL", "FRESHNESS" ], "type": "string" }, "interpolationType": { "enumDescriptions": [ "Interpolation type is unspecified. In this case, it defaults to Linear.", "Piecewise linear interpolation will be applied." ], "description": "Optional. The interpolation type to be applied to connect the control points listed below.", "enum": [ "INTERPOLATION_TYPE_UNSPECIFIED", "LINEAR" ], "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" } }, "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", "type": "object" }, "CitationsCitedChunk": { "description": "Piece of cited information.", "properties": { "title": { "description": "Title of the cited document.", "type": "string" }, "uri": { "description": "URI used for citation.", "type": "string" }, "text": { "description": "Text used for citation.", "type": "string" } }, "type": "object", "id": "CitationsCitedChunk" }, "TlsConfigCaCert": { "id": "TlsConfigCaCert", "type": "object", "properties": { "cert": { "type": "string", "description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile \u003c(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```", "format": "byte" }, "displayName": { "description": "Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.", "type": "string" } }, "description": "The CA certificate." }, "ConnectorTool": { "properties": { "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" }, "action": { "description": "Required. Action for the tool to use.", "$ref": "Action" }, "name": { "description": "Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.", "type": "string" }, "authConfig": { "description": "Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.", "$ref": "EndUserAuthConfig" } }, "description": "A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview.", "id": "ConnectorTool", "type": "object" }, "ErrorHandlingSettings": { "properties": { "fallbackResponseConfig": { "description": "Optional. Configuration for handling fallback responses.", "$ref": "ErrorHandlingSettingsFallbackResponseConfig" }, "endSessionConfig": { "description": "Optional. Configuration for ending the session in case of system errors (e.g. LLM errors).", "$ref": "ErrorHandlingSettingsEndSessionConfig" }, "errorHandlingStrategy": { "type": "string", "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)." ] } }, "description": "Settings to describe how errors should be handled in the app.", "id": "ErrorHandlingSettings", "type": "object" }, "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig": { "description": "The configuration to be used to generate an Open API schema.", "properties": { "uri": { "description": "Required. The base uri of the tool.", "type": "string" }, "operationGenerationConfigs": { "description": "Required. The list of operations to be added to the Open API schema.", "items": { "$ref": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig" }, "type": "array" } }, "type": "object", "id": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig" }, "OptimizationConfig": { "type": "object", "id": "OptimizationConfig", "description": "Configuration for running the optimization step after the evaluation run.", "properties": { "assistantSession": { "readOnly": true, "type": "string", "description": "Output only. The assistant session to use for the optimization based on this evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}`" }, "status": { "description": "Output only. The status of the optimization run.", "enum": [ "OPTIMIZATION_STATUS_UNSPECIFIED", "RUNNING", "COMPLETED", "ERROR" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Optimization status is not specified.", "Optimization is running.", "Optimization has completed.", "Optimization failed due to an internal error." ] }, "reportSummary": { "readOnly": true, "type": "string", "description": "Output only. The summary of the loss report." }, "generateLossReport": { "description": "Optional. Whether to generate a loss report.", "type": "boolean" }, "shouldSuggestFix": { "readOnly": true, "type": "boolean", "description": "Output only. Whether to suggest a fix for the losses." }, "errorMessage": { "readOnly": true, "type": "string", "description": "Output only. The error message if the optimization run failed." }, "lossReport": { "description": "Output only. The generated loss report.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "readOnly": true, "type": "object" } } }, "EvaluationMetricsConfigExpectationsMetMetricsConfig": { "id": "EvaluationMetricsConfigExpectationsMetMetricsConfig", "type": "object", "properties": { "enableExpectationsMetMetrics": { "description": "Optional. Whether to calculate the expectation level metrics for the evaluation.", "type": "boolean" } }, "description": "Configuration for the expectation level metrics for the evaluation. To disable the metric, set the message but do not set the `enable_expectations_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely." }, "GenerateAppResourceRequestEvaluationPersonasGenerationConfig": { "properties": {}, "description": "The configuration to be used to generate the evaluation personas.", "id": "GenerateAppResourceRequestEvaluationPersonasGenerationConfig", "type": "object" }, "ActionEntityOperation": { "description": "Entity CRUD operation specification.", "properties": { "entityId": { "description": "Required. ID of the entity.", "type": "string" }, "operation": { "enumDescriptions": [ "Operation type unspecified. Invalid, ConnectorTool create/update will fail.", "List operation.", "Get operation.", "Create operation.", "Update operation.", "Delete operation." ], "description": "Required. Operation to perform on the entity.", "enum": [ "OPERATION_TYPE_UNSPECIFIED", "LIST", "GET", "CREATE", "UPDATE", "DELETE" ], "type": "string" } }, "type": "object", "id": "ActionEntityOperation" }, "ListAgentsResponse": { "id": "ListAgentsResponse", "type": "object", "properties": { "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" }, "agents": { "type": "array", "items": { "$ref": "Agent" }, "description": "The list of agents." } }, "description": "Response message for AgentService.ListAgents." }, "ExportOptions": { "type": "object", "id": "ExportOptions", "description": "Options for exporting CES evaluation resources.", "properties": { "exportFormat": { "enumDescriptions": [ "Unspecified format.", "JSON format.", "YAML format." ], "description": "Optional. The format to export the evaluation results in. Defaults to JSON if not specified.", "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "type": "string" }, "gcsUri": { "description": "Optional. The Google Cloud Storage URI to write the exported Evaluation Results to.", "type": "string" } } }, "ListAppsResponse": { "properties": { "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Unordered list. Locations that could not be reached." }, "apps": { "items": { "$ref": "App" }, "type": "array", "description": "The list of apps." }, "nextPageToken": { "description": "A token that can be sent as ListAppsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } }, "description": "Response message for AgentService.ListApps.", "id": "ListAppsResponse", "type": "object" }, "ImportAppResponse": { "id": "ImportAppResponse", "type": "object", "properties": { "name": { "description": "The resource name of the app that was imported.", "type": "string" }, "warnings": { "items": { "type": "string" }, "type": "array", "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." } }, "description": "Response message for AgentService.ImportApp." }, "EvaluationPersonaSpeechConfig": { "type": "object", "id": "EvaluationPersonaSpeechConfig", "description": "Configuration for Text-to-Speech generation.", "properties": { "speakingRate": { "description": "Optional. The speaking rate. 1.0 is normal. Lower is slower (e.g., 0.8), higher is faster (e.g., 1.5). Useful for testing how the agent handles fast talkers.", "format": "double", "type": "number" }, "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" }, "voiceId": { "description": "Optional. The specific voice identifier/accent to use. Example: \"en-US-Wavenet-D\" or \"en-GB-Standard-A\"", "type": "string" } } }, "EvaluationMetricsThresholds": { "description": "Threshold settings for metrics in an Evaluation.", "properties": { "goldenEvaluationMetricsThresholds": { "description": "Optional. The golden evaluation metrics thresholds.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds" }, "scenarioHallucinationMetricBehavior": { "type": "string", "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ], "description": "Optional. The hallucination metric behavior for scenario evaluations.", "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ] }, "goldenHallucinationMetricBehavior": { "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ], "description": "Optional. The hallucination metric behavior for golden evaluations.", "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "type": "string" }, "hallucinationMetricBehavior": { "deprecated": true, "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ], "type": "string", "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" ] } }, "type": "object", "id": "EvaluationMetricsThresholds" }, "ConnectorToolset": { "properties": { "authConfig": { "description": "Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the Toolset creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override", "$ref": "EndUserAuthConfig" }, "connectorActions": { "items": { "$ref": "Action" }, "type": "array", "description": "Required. The list of connector actions/entity operations to generate tools for." }, "connection": { "description": "Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`", "type": "string" } }, "description": "A toolset that generates tools from an Integration Connectors Connection.", "id": "ConnectorToolset", "type": "object" }, "Message": { "id": "Message", "type": "object", "properties": { "role": { "description": "Optional. The role within the conversation, e.g., user, agent.", "type": "string" }, "chunks": { "description": "Optional. Content of the message as a series of chunks.", "items": { "$ref": "Chunk" }, "type": "array" }, "eventTime": { "type": "string", "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" } }, "description": "A message within a conversation." }, "Blob": { "id": "Blob", "type": "object", "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" }, "data": { "type": "string", "description": "Required. Raw bytes of the blob.", "format": "byte" } }, "description": "Represents a blob input or output in the conversation." }, "EvaluationScenarioUserFact": { "id": "EvaluationScenarioUserFact", "type": "object", "properties": { "name": { "description": "Required. The name of the user fact.", "type": "string" }, "value": { "description": "Required. The value of the user fact.", "type": "string" } }, "description": "Facts about the user as a key value pair." }, "WidgetToolTextResponseConfig": { "id": "WidgetToolTextResponseConfig", "type": "object", "properties": { "type": { "type": "string", "enumDescriptions": [ "Unspecified type.", "The LLM dynamically decides whether to generate a text response alongside the widget based on the conversation context.", "The LLM is explicitly required to generate a text response.", "A pre-defined static text response is always used." ], "description": "Optional. The strategy for providing the text response.", "enum": [ "TYPE_UNSPECIFIED", "NONE", "LLM_GENERATED", "STATIC" ] }, "textResponseInstruction": { "description": "Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.", "type": "string" }, "staticText": { "description": "Optional. The static text response to return when type is STATIC.", "type": "string" } }, "description": "Configuration for the text response returned with the widget." }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "properties": { "locations": { "type": "array", "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "type": "object", "id": "ListLocationsResponse" }, "Span": { "description": "A span is a unit of work or a single operation during the request processing.", "properties": { "startTime": { "readOnly": true, "type": "string", "description": "Output only. The start time of the span.", "format": "google-datetime" }, "endTime": { "readOnly": true, "type": "string", "description": "Output only. The end time of the span.", "format": "google-datetime" }, "name": { "readOnly": true, "type": "string", "description": "Output only. The name of the span." }, "childSpans": { "description": "Output only. The child spans that are nested under this span.", "readOnly": true, "type": "array", "items": { "$ref": "Span" } }, "duration": { "readOnly": true, "type": "string", "description": "Output only. The duration of the span.", "format": "google-duration" }, "attributes": { "description": "Output only. Key-value attributes associated with the span.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "readOnly": true, "type": "object" } }, "type": "object", "id": "Span" }, "GenerateAppResourceRequestQualityReportGenerationConfig": { "properties": { "evaluationRun": { "description": "Required. The evaluation run used to inform quality report analysis.", "type": "string" } }, "description": "The configuration to be used for quality report generation.", "id": "GenerateAppResourceRequestQualityReportGenerationConfig", "type": "object" }, "ExperimentConfigVersionReleaseTrafficAllocation": { "properties": { "trafficPercentage": { "type": "integer", "format": "int32", "description": "Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100." }, "appVersion": { "description": "Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "id": { "description": "Optional. Id of the traffic allocation. Free format string, up to 128 characters.", "type": "string" } }, "description": "Traffic allocation for the version release.", "id": "ExperimentConfigVersionReleaseTrafficAllocation", "type": "object" }, "DataStoreToolDataStoreSource": { "type": "object", "id": "DataStoreToolDataStoreSource", "description": "Configuration for searching within a specific DataStore.", "properties": { "filter": { "description": "Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata", "type": "string" }, "dataStore": { "description": "Optional. The data store.", "$ref": "DataStore" } } }, "McpTool": { "description": "An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details.", "properties": { "apiAuthentication": { "description": "Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.", "$ref": "ApiAuthentication" }, "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" }, "outputSchema": { "description": "Optional. The schema of the output arguments of the MCP tool.", "$ref": "Schema" }, "name": { "description": "Required. The name of the MCP tool.", "type": "string" }, "customHeaders": { "description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.", "additionalProperties": { "type": "string" }, "type": "object" }, "description": { "description": "Optional. The description of the MCP tool.", "type": "string" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.", "$ref": "ServiceDirectoryConfig" }, "inputSchema": { "description": "Optional. The schema of the input arguments of the MCP tool.", "$ref": "Schema" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust.", "$ref": "TlsConfig" } }, "type": "object", "id": "McpTool" }, "ServiceDirectoryConfig": { "id": "ServiceDirectoryConfig", "type": "object", "properties": { "service": { "description": "Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.", "type": "string" } }, "description": "Configuration for tools using Service Directory." }, "ExperimentConfig": { "type": "object", "id": "ExperimentConfig", "description": "Experiment for the deployment.", "properties": { "versionRelease": { "description": "Optional. Version release for the experiment.", "$ref": "ExperimentConfigVersionRelease" } } }, "TimeZoneSettings": { "type": "object", "id": "TimeZoneSettings", "description": "TimeZone settings of the app.", "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" } } }, "EvaluationMetricsConfigScenarioMetricsConfig": { "type": "object", "id": "EvaluationMetricsConfigScenarioMetricsConfig", "description": "Configuration for the scenario metrics for the evaluation.", "properties": { "userGoalMetMetricsConfig": { "description": "Optional. Configuration for user goal met metrics.", "$ref": "EvaluationMetricsConfigUserGoalMetMetricsConfig" }, "expectationsMetMetricsConfig": { "description": "Optional. Configuration for expectation level metrics.", "$ref": "EvaluationMetricsConfigExpectationsMetMetricsConfig" } } }, "ScheduledEvaluationRun": { "id": "ScheduledEvaluationRun", "type": "object", "properties": { "displayName": { "description": "Required. User-defined display name of the scheduled evaluation run config.", "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" }, "updateTime": { "description": "Output only. Timestamp when the evaluation was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" }, "request": { "description": "Required. The RunEvaluationRequest to schedule", "$ref": "RunEvaluationRequest" }, "lastUpdatedBy": { "readOnly": true, "type": "string", "description": "Output only. The user who last updated the evaluation." }, "description": { "description": "Optional. User-defined description of the scheduled evaluation run.", "type": "string" }, "nextScheduledExecutionTime": { "description": "Output only. The next time this is scheduled to execute", "format": "google-datetime", "readOnly": true, "type": "string" }, "createdBy": { "readOnly": true, "type": "string", "description": "Output only. The user who created the scheduled evaluation run." }, "totalExecutions": { "description": "Output only. The total number of times this run has been executed", "format": "int32", "readOnly": true, "type": "integer" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when the scheduled evaluation run was created." }, "active": { "description": "Optional. Whether this config is active", "type": "boolean" }, "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" }, "schedulingConfig": { "description": "Required. Configuration for the timing and frequency with which to execute the evaluations.", "$ref": "ScheduledEvaluationRunSchedulingConfig" }, "etag": { "readOnly": true, "type": "string", "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." } }, "description": "Represents a scheduled evaluation run configuration." }, "ServiceAccountAuthConfig": { "id": "ServiceAccountAuthConfig", "type": "object", "properties": { "serviceAccount": { "description": "Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.", "type": "string" }, "scopes": { "description": "Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.", "type": "array", "items": { "type": "string" } } }, "description": "Configurations for authentication using a custom service account." }, "AggregatedMetricsToolCallLatencyMetrics": { "type": "object", "id": "AggregatedMetricsToolCallLatencyMetrics", "description": "Metrics for tool call latency.", "properties": { "tool": { "readOnly": true, "type": "string", "description": "Output only. The name of the tool." }, "averageLatency": { "description": "Output only. The average latency of the tool calls.", "format": "google-duration", "readOnly": true, "type": "string" } } }, "ExportEvaluationRunsRequest": { "type": "object", "id": "ExportEvaluationRunsRequest", "description": "Request message for EvaluationService.ExportEvaluationRuns.", "properties": { "names": { "type": "array", "items": { "type": "string" }, "description": "Required. The resource names of the evaluation runs to export." }, "exportOptions": { "description": "Optional. The export options for the evaluation runs.", "$ref": "ExportOptions" } } }, "OperationMetadata": { "properties": { "requestedCancellation": { "readOnly": true, "type": "boolean", "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "statusMessage": { "readOnly": true, "type": "string", "description": "Output only. Human-readable status of the operation, if any." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." } }, "description": "Represents the metadata of the long-running operation.", "id": "OperationMetadata", "type": "object" }, "ExportEvaluationsResponse": { "id": "ExportEvaluationsResponse", "type": "object", "properties": { "evaluationsUri": { "description": "The Google Cloud Storage URI folder where the exported evaluations were written. This will be populated if gcs_uri was specified in the request.", "type": "string" }, "evaluationsContent": { "type": "string", "format": "byte", "description": "The content of the exported Evaluations. This will be populated if gcs_uri was not specified in the request." }, "failedEvaluations": { "description": "Output only. A map of evaluation resource names that could not be exported, to the reason why they failed.", "additionalProperties": { "type": "string" }, "readOnly": true, "type": "object" } }, "description": "Response message for EvaluationService.ExportEvaluations." }, "BigQueryExportSettings": { "properties": { "enabled": { "description": "Optional. Indicates whether the BigQuery export is enabled.", "type": "boolean" }, "dataset": { "description": "Optional. The BigQuery **dataset ID** to export the data to.", "type": "string" }, "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" } }, "description": "Settings to describe the BigQuery export behaviors for the app.", "id": "BigQueryExportSettings", "type": "object" }, "ToolFakeConfig": { "id": "ToolFakeConfig", "type": "object", "properties": { "codeBlock": { "description": "Optional. Code block which will be executed instead of a real tool call.", "$ref": "CodeBlock" }, "enableFakeMode": { "description": "Optional. Whether the tool is using fake mode.", "type": "boolean" } }, "description": "Configuration for tool behavior in fake mode." }, "SynthesizeSpeechConfig": { "type": "object", "id": "SynthesizeSpeechConfig", "description": "Configuration for how the agent response should be synthesized.", "properties": { "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" }, "speakingRate": { "format": "double", "description": "Optional. The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.", "type": "number" } } }, "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" } }, "description": "Response message for AgentService.ListGuardrails.", "id": "ListGuardrailsResponse", "type": "object" }, "ListAppVersionsResponse": { "description": "Response message for AgentService.ListAppVersions.", "properties": { "nextPageToken": { "description": "A token that can be sent as ListAppVersionsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" }, "appVersions": { "description": "The list of app versions.", "items": { "$ref": "AppVersion" }, "type": "array" } }, "type": "object", "id": "ListAppVersionsResponse" }, "ClientFunction": { "properties": { "parameters": { "description": "Optional. The schema of the function parameters.", "$ref": "Schema" }, "description": { "description": "Optional. The function description.", "type": "string" }, "response": { "description": "Optional. The schema of the function response.", "$ref": "Schema" }, "name": { "description": "Required. The function name.", "type": "string" } }, "description": "Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent.", "id": "ClientFunction", "type": "object" }, "DataStoreTool": { "type": "object", "id": "DataStoreTool", "description": "Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.", "properties": { "engineSource": { "description": "Optional. Search within an Engine (potentially across multiple DataStores).", "$ref": "DataStoreToolEngineSource" }, "modalityConfigs": { "type": "array", "items": { "$ref": "DataStoreToolModalityConfig" }, "description": "Optional. The modality configs for the data store." }, "name": { "description": "Required. The data store tool name.", "type": "string" }, "boostSpecs": { "items": { "$ref": "DataStoreToolBoostSpecs" }, "type": "array", "description": "Optional. Boost specification to boost certain documents." }, "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" }, "description": { "description": "Optional. The tool description.", "type": "string" }, "dataStoreSource": { "description": "Optional. Search within a single specific DataStore.", "$ref": "DataStoreToolDataStoreSource" } } }, "LatencyReport": { "properties": { "toolLatencies": { "description": "Output only. Unordered list. Latency metrics for each tool.", "items": { "$ref": "LatencyReportToolLatency" }, "readOnly": true, "type": "array" }, "llmCallLatencies": { "description": "Output only. Unordered list. Latency metrics for each LLM call.", "readOnly": true, "type": "array", "items": { "$ref": "LatencyReportLlmCallLatency" } }, "sessionCount": { "description": "Output only. The total number of sessions considered in the latency report.", "format": "int32", "readOnly": true, "type": "integer" }, "callbackLatencies": { "description": "Output only. Unordered list. Latency metrics for each callback.", "items": { "$ref": "LatencyReportCallbackLatency" }, "readOnly": true, "type": "array" }, "guardrailLatencies": { "readOnly": true, "type": "array", "items": { "$ref": "LatencyReportGuardrailLatency" }, "description": "Output only. Unordered list. Latency metrics for each guardrail." } }, "description": "Latency report for the evaluation run.", "id": "LatencyReport", "type": "object" }, "TestPersonaVoiceRequest": { "properties": { "text": { "description": "Required. The text to test the voice for.", "type": "string" }, "personaId": { "description": "Required. The persona ID to test the voice for. Also accepts \"default\".", "type": "string" } }, "description": "Request message for EvaluationService.TestPersonaVoice.", "id": "TestPersonaVoiceRequest", "type": "object" }, "DeleteEvaluationRunOperationMetadata": { "properties": {}, "description": "Operation metadata for EvaluationService.DeleteEvaluationRun.", "id": "DeleteEvaluationRunOperationMetadata", "type": "object" }, "EvaluationResultGoldenResultTurnReplayResult": { "properties": { "toolOrderedInvocationScore": { "readOnly": true, "type": "number", "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" }, "overallToolInvocationResult": { "readOnly": true, "description": "Output only. The result of the overall tool invocation check.", "$ref": "EvaluationResultOverallToolInvocationResult" }, "conversation": { "readOnly": true, "type": "string", "description": "Output only. The conversation that was generated for this turn." }, "expectationOutcome": { "description": "Output only. The outcome of each expectation.", "items": { "$ref": "EvaluationResultGoldenExpectationOutcome" }, "readOnly": true, "type": "array" }, "spanLatencies": { "description": "Output only. The latency of spans in the turn.", "items": { "$ref": "EvaluationResultSpanLatency" }, "readOnly": true, "type": "array" }, "toolInvocationScore": { "format": "float", "description": "Output only. Deprecated. Use OverallToolInvocationResult instead.", "deprecated": true, "readOnly": true, "type": "number" }, "hallucinationResult": { "readOnly": true, "description": "Output only. The result of the hallucination check.", "$ref": "EvaluationResultHallucinationResult" }, "turnLatency": { "format": "google-duration", "description": "Output only. Duration of the turn.", "readOnly": true, "type": "string" }, "toolCallLatencies": { "readOnly": true, "type": "array", "items": { "$ref": "EvaluationResultToolCallLatency" }, "description": "Output only. The latency of each tool call in the turn." }, "semanticSimilarityResult": { "description": "Output only. The result of the semantic similarity check.", "$ref": "EvaluationResultSemanticSimilarityResult", "readOnly": true }, "errorInfo": { "description": "Output only. Information about the error that occurred during this turn.", "$ref": "EvaluationErrorInfo", "readOnly": true } }, "description": "The result of running a single turn of the golden conversation.", "id": "EvaluationResultGoldenResultTurnReplayResult", "type": "object" }, "GuardrailContentFilter": { "properties": { "bannedContentsInAgentResponse": { "description": "Optional. List of banned phrases. Applies only to agent responses.", "type": "array", "items": { "type": "string" } }, "bannedContents": { "items": { "type": "string" }, "type": "array", "description": "Optional. List of banned phrases. Applies to both user inputs and agent responses." }, "disregardDiacritics": { "description": "Optional. If true, diacritics are ignored during matching.", "type": "boolean" }, "bannedContentsInUserInput": { "description": "Optional. List of banned phrases. Applies only to user inputs.", "type": "array", "items": { "type": "string" } }, "matchType": { "type": "string", "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." ] } }, "description": "Guardrail that bans certain content from being used in the conversation.", "id": "GuardrailContentFilter", "type": "object" }, "ListEvaluationExpectationsResponse": { "type": "object", "id": "ListEvaluationExpectationsResponse", "description": "Response message for EvaluationService.ListEvaluationExpectations.", "properties": { "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" }, "evaluationExpectations": { "description": "The list of evaluation expectations.", "type": "array", "items": { "$ref": "EvaluationExpectation" } } } }, "DataStoreToolModalityConfig": { "id": "DataStoreToolModalityConfig", "type": "object", "properties": { "groundingConfig": { "description": "Optional. The grounding configuration.", "$ref": "DataStoreToolGroundingConfig" }, "modalityType": { "type": "string", "enumDescriptions": [ "Unspecified modality type.", "Text modality.", "Audio modality." ], "description": "Required. The modality type.", "enum": [ "MODALITY_TYPE_UNSPECIFIED", "TEXT", "AUDIO" ] }, "summarizationConfig": { "description": "Optional. The summarization config.", "$ref": "DataStoreToolSummarizationConfig" }, "rewriterConfig": { "description": "Optional. The rewriter config.", "$ref": "DataStoreToolRewriterConfig" } }, "description": "If specified, will apply the given configuration for the specified modality." }, "GoogleSearchToolPromptConfig": { "description": "Prompt settings used by the model when processing or summarizing the google search results.", "properties": { "voicePrompt": { "description": "Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.", "type": "string" }, "textPrompt": { "description": "Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.", "type": "string" } }, "type": "object", "id": "GoogleSearchToolPromptConfig" }, "TransferRule": { "properties": { "deterministicTransfer": { "description": "Optional. A rule that immediately transfers to the target agent when the condition is met.", "$ref": "TransferRuleDeterministicTransfer" }, "childAgent": { "description": "Required. The resource name of the child agent the rule applies to. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "disablePlannerTransfer": { "description": "Optional. Rule that prevents the planner from transferring to the target agent.", "$ref": "TransferRuleDisablePlannerTransfer" }, "direction": { "type": "string", "enumDescriptions": [ "Unspecified direction.", "Transfer from the parent agent to the child agent.", "Transfer from the child agent to the parent agent." ], "description": "Required. The direction of the transfer.", "enum": [ "DIRECTION_UNSPECIFIED", "PARENT_TO_CHILD", "CHILD_TO_PARENT" ] } }, "description": "Rule for transferring to a specific agent.", "id": "TransferRule", "type": "object" }, "ModelSettings": { "id": "ModelSettings", "type": "object", "properties": { "model": { "description": "Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.", "type": "string" }, "temperature": { "type": "number", "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" } }, "description": "Model settings contains various configurations for the LLM model." }, "PythonCodeCondition": { "properties": { "pythonCode": { "description": "Required. The python code to execute.", "type": "string" } }, "description": "Python code block to evaluate the condition.", "id": "PythonCodeCondition", "type": "object" }, "EvaluationResultScenarioResult": { "description": "The outcome of a scenario evaluation.", "properties": { "evaluationExpectationResults": { "description": "Output only. The results of the evaluation expectations.", "readOnly": true, "type": "array", "items": { "$ref": "EvaluationResultEvaluationExpectationResult" } }, "taskCompletionResult": { "readOnly": true, "deprecated": true, "description": "Output only. The result of the task completion check.", "$ref": "EvaluationResultTaskCompletionResult" }, "taskCompleted": { "readOnly": true, "type": "boolean", "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." }, "userGoalSatisfactionResult": { "readOnly": true, "description": "Output only. The result of the user goal satisfaction check.", "$ref": "EvaluationResultUserGoalSatisfactionResult" }, "conversation": { "readOnly": true, "type": "string", "description": "Output only. The conversation that was generated in the scenario." }, "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" }, "toolCallLatencies": { "description": "Output only. The latency of each tool call execution in the conversation.", "readOnly": true, "type": "array", "items": { "$ref": "EvaluationResultToolCallLatency" } }, "userFacts": { "items": { "$ref": "EvaluationScenarioUserFact" }, "readOnly": true, "type": "array", "description": "Output only. The user facts that were used by the scenario for this result." }, "rubricOutcomes": { "description": "Output only. The outcome of the rubric.", "readOnly": true, "type": "array", "items": { "$ref": "EvaluationResultScenarioRubricOutcome" } }, "task": { "description": "Output only. The task that was used when running the scenario for this result.", "readOnly": true, "type": "string" }, "spanLatencies": { "description": "Output only. The latency of spans in the conversation.", "readOnly": true, "type": "array", "items": { "$ref": "EvaluationResultSpanLatency" } }, "expectationOutcomes": { "items": { "$ref": "EvaluationResultScenarioExpectationOutcome" }, "readOnly": true, "type": "array", "description": "Output only. The outcome of each expectation." }, "allExpectationsSatisfied": { "description": "Output only. Whether all expectations were satisfied for this turn.", "readOnly": true, "type": "boolean" } }, "type": "object", "id": "EvaluationResultScenarioResult" }, "EvaluationResult": { "type": "object", "id": "EvaluationResult", "description": "An evaluation result represents the output of running an Evaluation.", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when the evaluation result was created." }, "error": { "readOnly": true, "deprecated": true, "description": "Output only. Deprecated: Use `error_info` instead. Errors encountered during execution.", "$ref": "Status" }, "appVersion": { "readOnly": true, "type": "string", "description": "Output only. The app version used to generate the conversation that resulted in this result. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`" }, "scenarioResult": { "readOnly": true, "description": "Output only. The outcome of a scenario evaluation.", "$ref": "EvaluationResultScenarioResult" }, "changelogCreateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "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." }, "goldenRunMethod": { "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", "description": "Output only. The method used to run the golden evaluation.", "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ] }, "appVersionDisplayName": { "readOnly": true, "type": "string", "description": "Output only. The display name of the `app_version` that the evaluation ran against." }, "evaluationMetricsThresholds": { "description": "Output only. The evaluation thresholds for the result.", "$ref": "EvaluationMetricsThresholds", "readOnly": true }, "changelog": { "readOnly": true, "type": "string", "description": "Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft." }, "goldenResult": { "readOnly": true, "description": "Output only. The outcome of a golden evaluation.", "$ref": "EvaluationResultGoldenResult" }, "evaluationRun": { "readOnly": true, "type": "string", "description": "Output only. The evaluation run that produced this result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`" }, "evaluationStatus": { "readOnly": true, "type": "string", "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ], "description": "Output only. The outcome of the evaluation. Only populated if execution_state is COMPLETE.", "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ] }, "persona": { "readOnly": true, "description": "Output only. The persona used to generate the conversation for the evaluation result.", "$ref": "EvaluationPersona" }, "errorInfo": { "description": "Output only. Error information for the evaluation result.", "$ref": "EvaluationErrorInfo", "readOnly": true }, "executionState": { "readOnly": true, "type": "string", "enumDescriptions": [ "Evaluation result execution state is not specified.", "Evaluation result execution is running.", "Evaluation result execution has completed.", "Evaluation result execution failed due to an internal error." ], "description": "Output only. The state of the evaluation result execution.", "enum": [ "EXECUTION_STATE_UNSPECIFIED", "RUNNING", "COMPLETED", "ERROR" ] }, "initiatedBy": { "readOnly": true, "type": "string", "description": "Output only. The user who initiated the evaluation run that resulted in this result." }, "config": { "description": "Output only. The configuration used in the evaluation run that resulted in this result.", "$ref": "EvaluationConfig", "readOnly": true }, "displayName": { "description": "Required. Display name of the Evaluation Result. Unique within an Evaluation. By default, it has the following format: \" result - \".", "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" } } }, "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.", "properties": { "metadata": { "description": "Optional. Provides additional information about the end session signal, such as the reason for ending the session.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "type": "object", "id": "EndSession" }, "ExportEvaluationRunsResponse": { "description": "Response message for EvaluationService.ExportEvaluationRuns.", "properties": { "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" }, "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" } }, "type": "object", "id": "ExportEvaluationRunsResponse" }, "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" }, "responseJson": { "description": "Required. A sample response from the tool in JSON format.", "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" } }, "description": "The configuration to be used to generate an operation in the Open API schema.", "id": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig", "type": "object" }, "EvaluationScenarioExpectation": { "description": "The expectation to evaluate the conversation produced by the simulation.", "properties": { "agentResponse": { "description": "Optional. The agent response to be evaluated.", "$ref": "Message" }, "toolExpectation": { "description": "Optional. The tool call and response pair to be evaluated.", "$ref": "EvaluationScenarioExpectationToolExpectation" } }, "type": "object", "id": "EvaluationScenarioExpectation" }, "EvaluationMetricsConfigSemanticSimilarityMetricsConfig": { "type": "object", "id": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig", "description": "Configuration for similarity metrics for the evaluation. To disable the metric, set the message but do not set the `enable_semantic_similarity_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", "properties": { "enableSemanticSimilarityMetrics": { "description": "Optional. Whether to calculate semantic similarity metrics for the evaluation.", "type": "boolean" } } }, "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" } }, "description": "Response message for AgentService.ListExamples.", "id": "ListExamplesResponse", "type": "object" }, "GenerateAppResourceRequest": { "id": "GenerateAppResourceRequest", "type": "object", "properties": { "toolset": { "description": "The toolset resource to be used by the LLM assistant, can be empty for generating a new toolset.", "$ref": "Toolset" }, "agent": { "description": "The agent resource to be used by the LLM assistant, can be empty for generating a new agent.", "$ref": "Agent" }, "toolGenerationConfig": { "description": "Optional. The configuration to be used to generate the tool.", "$ref": "GenerateAppResourceRequestToolGenerationConfig" }, "evaluationGenerationConfig": { "description": "Optional. The configuration to be used to generate the evaluations.", "$ref": "GenerateAppResourceRequestEvaluationGenerationConfig" }, "qualityReportGenerationConfig": { "description": "Optional. The configuration to be used for quality report generation.", "$ref": "GenerateAppResourceRequestQualityReportGenerationConfig" }, "refineInstructions": { "description": "Optional. List of refine instructions to be used to refine the resource.", "type": "array", "items": { "$ref": "GenerateAppResourceRequestRefineInstructions" } }, "evaluationPersonasGenerationConfig": { "description": "Optional. The configuration to be used to generate the evaluation personas.", "$ref": "GenerateAppResourceRequestEvaluationPersonasGenerationConfig" }, "hillClimbingFixConfig": { "description": "Optional. The configuration to be used for hill climbing fixes.", "$ref": "GenerateAppResourceRequestHillClimbingFixConfig" }, "appGenerationConfig": { "description": "Optional. The configuration to be used to generate the agents and tools.", "$ref": "GenerateAppResourceRequestAppGenerationConfig" }, "tool": { "description": "The tool resource to be used by the LLM assistant, can be empty for generating a new tool.", "$ref": "Tool" } }, "description": "Request message for AgentService.GenerateAppResource." }, "ImportEvaluationsRequestConversationList": { "id": "ImportEvaluationsRequestConversationList", "type": "object", "properties": { "conversations": { "description": "Optional. Conversation resource names.", "type": "array", "items": { "type": "string" } } }, "description": "A list of conversation resource names." }, "EvaluationMetricsConfig": { "properties": { "goldenMetricsConfig": { "description": "Optional. Configuration for the golden metrics for the evaluation.", "$ref": "EvaluationMetricsConfigGoldenMetricsConfig" }, "scenarioMetricsConfig": { "description": "Optional. Configuration for the scenario metrics for the evaluation.", "$ref": "EvaluationMetricsConfigScenarioMetricsConfig" } }, "description": "Configures the metrics for an evaluation.", "id": "EvaluationMetricsConfig", "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\".", "properties": { "startIndex": { "type": "string", "format": "int64", "description": "Required. The first character (inclusive) of the text to refine." }, "endIndex": { "type": "string", "description": "Required. The last character (inclusive) of the text to refine.", "format": "int64" }, "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" } }, "type": "object", "id": "GenerateAppResourceRequestRefineInstructions" }, "EvaluationMetricsThresholdsToolMatchingSettings": { "type": "object", "id": "EvaluationMetricsThresholdsToolMatchingSettings", "description": "Settings for matching tool calls.", "properties": { "extraToolCallBehavior": { "type": "string", "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." ] } } }, "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).", "properties": { "attributeValue": { "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" }, "boostAmount": { "type": "number", "format": "float", "description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above." } }, "type": "object", "id": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, "McpToolset": { "id": "McpToolset", "type": "object", "properties": { "apiAuthentication": { "description": "Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.", "$ref": "ApiAuthentication" }, "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" }, "customHeaders": { "description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.", "additionalProperties": { "type": "string" }, "type": "object" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.", "$ref": "ServiceDirectoryConfig" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust.", "$ref": "TlsConfig" } }, "description": "A toolset that contains a list of tools that are offered by the MCP server." }, "DataStoreToolRewriterConfig": { "description": "Rewriter configuration.", "properties": { "prompt": { "description": "Optional. The prompt definition. If not set, default prompt will be used.", "type": "string" }, "modelSettings": { "description": "Required. Configurations for the LLM model.", "$ref": "ModelSettings" }, "disabled": { "description": "Optional. Whether the rewriter is disabled.", "type": "boolean" } }, "type": "object", "id": "DataStoreToolRewriterConfig" }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds": { "type": "object", "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds", "description": "Expectation level metrics thresholds.", "properties": { "toolInvocationParameterCorrectnessThreshold": { "format": "float", "description": "Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.", "type": "number" } } }, "ScheduledEvaluationRunSchedulingConfig": { "properties": { "startTime": { "format": "google-datetime", "description": "Required. Timestamp when the eval should start.", "type": "string" }, "frequency": { "enumDescriptions": [ "The frequency is unspecified.", "Indicates a one-time scheduled run that should not repeat", "Run the evaluation daily.", "Run the evaluation weekly.", "Run the evaluation biweekly." ], "description": "Required. The frequency with which to run the eval", "enum": [ "FREQUENCY_UNSPECIFIED", "NONE", "DAILY", "WEEKLY", "BIWEEKLY" ], "type": "string" }, "daysOfWeek": { "description": "Optional. The days of the week to run the eval. Applicable only for Weekly and Biweekly frequencies. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday.", "type": "array", "items": { "type": "integer", "format": "int32" } } }, "description": "Eval scheduling configuration details", "id": "ScheduledEvaluationRunSchedulingConfig", "type": "object" }, "RetrieveToolsRequest": { "type": "object", "id": "RetrieveToolsRequest", "description": "Request message for ToolService.RetrieveTools.", "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" } } }, "GenerateChatTokenResponse": { "id": "GenerateChatTokenResponse", "type": "object", "properties": { "chatToken": { "description": "The session scoped token for chat widget to authenticate with Session APIs.", "type": "string" }, "expireTime": { "format": "google-datetime", "description": "The time at which the chat token expires.", "type": "string" } }, "description": "Response message for WidgetService.GenerateChatToken." }, "SecuritySettings": { "description": "Project/Location level security settings for CES.", "properties": { "endpointControlPolicy": { "description": "Optional. Endpoint control related settings.", "$ref": "EndpointControlPolicy" }, "name": { "description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`", "type": "string" }, "etag": { "description": "Output only. Etag of the security settings.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. Create time of the security settings.", "format": "google-datetime", "readOnly": true, "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Last update time of the security settings." } }, "type": "object", "id": "SecuritySettings" }, "RetrieveToolSchemaResponse": { "id": "RetrieveToolSchemaResponse", "type": "object", "properties": { "toolsetTool": { "description": "The toolset tool that the schema is for.", "$ref": "ToolsetTool" }, "tool": { "description": "The name of the tool that the schema is for. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "inputSchema": { "description": "The schema of the tool input parameters.", "$ref": "Schema" }, "outputSchema": { "description": "The schema of the tool output parameters.", "$ref": "Schema" } }, "description": "Response message for ToolService.RetrieveToolSchema." }, "Callback": { "id": "Callback", "type": "object", "properties": { "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" }, "disabled": { "description": "Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.", "type": "boolean" }, "pythonCode": { "description": "Required. The python code to execute for the callback.", "type": "string" }, "description": { "description": "Optional. Human-readable description of the callback.", "type": "string" } }, "description": "A callback defines the custom logic to be executed at various stages of agent interaction." }, "EvaluationExpectationLlmCriteria": { "id": "EvaluationExpectationLlmCriteria", "type": "object", "properties": { "prompt": { "description": "Required. The prompt/instructions provided to the LLM judge.", "type": "string" } }, "description": "Configuration for LLM-based evaluation criteria." }, "ListToolsetsResponse": { "type": "object", "id": "ListToolsetsResponse", "description": "Response message for AgentService.ListToolsets.", "properties": { "toolsets": { "description": "The list of toolsets.", "items": { "$ref": "Toolset" }, "type": "array" }, "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" } } }, "Empty": { "properties": {}, "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", "type": "object" }, "FileContextFileBytes": { "id": "FileContextFileBytes", "type": "object", "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" }, "fileName": { "description": "Required. The name of the file provided as raw bytes.", "type": "string" }, "data": { "type": "string", "description": "Required. Raw bytes of the file.", "format": "byte" } }, "description": "File provided as raw bytes." }, "LanguageSettings": { "id": "LanguageSettings", "type": "object", "properties": { "supportedLanguageCodes": { "description": "Optional. List of languages codes supported by the app, in addition to the `default_language_code`.", "items": { "type": "string" }, "type": "array" }, "enableMultilingualSupport": { "description": "Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.", "type": "boolean" }, "defaultLanguageCode": { "description": "Optional. The default language code of the app.", "type": "string" }, "fallbackAction": { "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" } }, "description": "Language settings of the app." }, "ConversationLoggingSettings": { "type": "object", "id": "ConversationLoggingSettings", "description": "Settings to describe the conversation logging behaviors for the app.", "properties": { "disableConversationLogging": { "description": "Optional. Whether to disable conversation logging for the sessions.", "type": "boolean" }, "retentionWindow": { "type": "string", "format": "google-duration", "description": "Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days." } } }, "OAuthConfig": { "properties": { "scopes": { "type": "array", "items": { "type": "string" }, "description": "Optional. The OAuth scopes to grant." }, "oauthGrantType": { "type": "string", "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)." ] }, "clientSecretVersion": { "description": "Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.", "type": "string" }, "tokenEndpoint": { "description": "Required. The token endpoint in the OAuth provider to exchange for an access token.", "type": "string" }, "clientId": { "description": "Required. The client ID from the OAuth provider.", "type": "string" } }, "description": "Configurations for authentication with OAuth.", "id": "OAuthConfig", "type": "object" }, "GenerateChatTokenRequest": { "id": "GenerateChatTokenRequest", "type": "object", "properties": { "deployment": { "description": "Required. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}", "type": "string" }, "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" } }, "description": "Request message for WidgetService.GenerateChatToken." }, "AggregatedMetricsMetricsByTurn": { "id": "AggregatedMetricsMetricsByTurn", "type": "object", "properties": { "toolMetrics": { "readOnly": true, "type": "array", "items": { "$ref": "AggregatedMetricsToolMetrics" }, "description": "Output only. Metrics for each tool within this turn." }, "turnIndex": { "readOnly": true, "type": "integer", "description": "Output only. The turn index (0-based).", "format": "int32" }, "turnLatencyMetrics": { "description": "Output only. Metrics for turn latency within this turn.", "readOnly": true, "type": "array", "items": { "$ref": "AggregatedMetricsTurnLatencyMetrics" } }, "semanticSimilarityMetrics": { "description": "Output only. Metrics for semantic similarity within this turn.", "items": { "$ref": "AggregatedMetricsSemanticSimilarityMetrics" }, "readOnly": true, "type": "array" }, "toolCallLatencyMetrics": { "readOnly": true, "type": "array", "items": { "$ref": "AggregatedMetricsToolCallLatencyMetrics" }, "description": "Output only. Metrics for tool call latency within this turn." }, "hallucinationMetrics": { "description": "Output only. Metrics for hallucination within this turn.", "items": { "$ref": "AggregatedMetricsHallucinationMetrics" }, "readOnly": true, "type": "array" } }, "description": "Metrics aggregated per turn." }, "EvaluationResultGoldenExpectationOutcome": { "description": "Specifies the expectation and the result of that expectation.", "properties": { "expectation": { "readOnly": true, "description": "Output only. The expectation that was evaluated.", "$ref": "EvaluationGoldenExpectation" }, "observedAgentTransfer": { "readOnly": true, "description": "Output only. The result of the agent transfer expectation.", "$ref": "AgentTransfer" }, "observedToolCall": { "readOnly": true, "description": "Output only. The result of the tool call expectation.", "$ref": "ToolCall" }, "observedAgentResponse": { "description": "Output only. The result of the agent response expectation.", "$ref": "Message", "readOnly": true }, "outcome": { "description": "Output only. The outcome of the expectation.", "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "readOnly": true, "type": "string", "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." ] }, "observedToolResponse": { "description": "Output only. The result of the tool response expectation.", "$ref": "ToolResponse", "readOnly": true }, "observedPayload": { "description": "Output only. An observed custom payload. There are no expectations for custom payloads. This is only used for metrics calculation. The outcome is always SKIPPED.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "readOnly": true, "type": "object" }, "semanticSimilarityResult": { "readOnly": true, "deprecated": true, "description": "Output only. The result of the semantic similarity check.", "$ref": "EvaluationResultSemanticSimilarityResult" }, "toolInvocationResult": { "description": "Output only. The result of the tool invocation check.", "$ref": "EvaluationResultGoldenExpectationOutcomeToolInvocationResult", "readOnly": true } }, "type": "object", "id": "EvaluationResultGoldenExpectationOutcome" }, "Example": { "type": "object", "id": "Example", "description": "An example represents a sample conversation between the user and the agent(s).", "properties": { "description": { "description": "Optional. Human-readable description 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" }, "messages": { "items": { "$ref": "Message" }, "type": "array", "description": "Optional. The collection of messages that make up the conversation." }, "displayName": { "description": "Required. Display name of the example.", "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" }, "name": { "description": "Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the example was created.", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when the example was last updated.", "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" } } } }, "name": "ces", "protocol": "rest", "endpoints": [ { "endpointUrl": "https://ces.us.rep.googleapis.com/", "location": "us", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "eu", "endpointUrl": "https://ces.eu.rep.googleapis.com/" } ], "kind": "discovery#restDescription", "parameters": { "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean", "location": "query" }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "location": "query" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "access_token": { "type": "string", "location": "query", "description": "OAuth access token." }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "default": "json", "location": "query" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "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.", "type": "string", "location": "query" }, "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.", "type": "string", "location": "query" } }, "version_module": true, "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": "", "documentationLink": "https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps" }