google-api-python-client 2.192.0__py3-none-any.whl → 2.194.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/ces.v1.json

@@ -17,7 +17,7 @@
 "canonicalName": "Customer Engagement Suite",
 "description": "",
 "discoveryVersion": "v1",
-"documentationLink": "https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference",
+"documentationLink": "https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps",
 "endpoints": [
 {
 "description": "Regional Endpoint",
@@ -151,7 +151,7 @@
 ]
 },
 "list": {
-"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
+"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.",
 "flatPath": "v1/projects/{projectsId}/locations",
 "httpMethod": "GET",
 "id": "ces.projects.locations.list",
@@ -1095,7 +1095,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}",
+"description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$",
 "required": true,
@@ -1513,7 +1513,7 @@
 ]
 },
 "runSession": {
-"description": "Initiates a single turn interaction with the CES agent within a session.",
+"description": "Initiates a single-turn interaction with the CES agent within a session.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:runSession",
 "httpMethod": "POST",
 "id": "ces.projects.locations.apps.sessions.runSession",
@@ -1540,6 +1540,35 @@
 "https://www.googleapis.com/auth/ces",
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"streamRunSession": {
+"description": "Initiates a single-turn interaction with the CES agent. Uses server-side streaming to deliver incremental results and partial responses as they are generated. By default, complete responses (e.g., messages from callbacks or full LLM responses) are sent to the client as soon as they are available. To enable streaming individual text chunks directly from the model, set enable_text_streaming to true.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:streamRunSession",
+"httpMethod": "POST",
+"id": "ces.projects.locations.apps.sessions.streamRunSession",
+"parameterOrder": [
+"session"
+],
+"parameters": {
+"session": {
+"description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+session}:streamRunSession",
+"request": {
+"$ref": "RunSessionRequest"
+},
+"response": {
+"$ref": "RunSessionResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/ces",
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 }
 },
@@ -1698,7 +1727,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Identifier. The unique identifier 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.",
+"description": "Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$",
 "required": true,
@@ -2246,7 +2275,7 @@
 }
 }
 },
-"revision": "20260218",
+"revision": "20260325",
 "rootUrl": "https://ces.googleapis.com/",
 "schemas": {
 "Action": {
@@ -2503,6 +2532,25 @@
 },
 "type": "object"
 },
+"AgentTool": {
+"description": "Represents a tool that allows the agent to call another agent.",
+"id": "AgentTool",
+"properties": {
+"description": {
+"description": "Optional. Description of the tool's purpose.",
+"type": "string"
+},
+"name": {
+"description": "Required. The name of the agent tool.",
+"type": "string"
+},
+"rootAgent": {
+"description": "Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`",
+"type": "string"
+}
+},
+"type": "object"
+},
 "AgentTransfer": {
 "description": "Represents an event indicating the transfer of a conversation to a different agent.",
 "id": "AgentTransfer",
@@ -2652,6 +2700,10 @@
 "description": "Required. Display name of the app.",
 "type": "string"
 },
+"errorHandlingSettings": {
+"$ref": "ErrorHandlingSettings",
+"description": "Optional. Error handling settings of the app."
+},
 "etag": {
 "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.",
 "readOnly": true,
@@ -2942,7 +2994,7 @@
 "id": "BigQueryExportSettings",
 "properties": {
 "dataset": {
-"description": "Optional. The BigQuery dataset to export the data to.",
+"description": "Optional. The BigQuery **dataset ID** to export the data to.",
 "type": "string"
 },
 "enabled": {
@@ -2950,7 +3002,7 @@
 "type": "boolean"
 },
 "project": {
-"description": "Optional. The project ID of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.",
+"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"
 }
 },
@@ -3170,13 +3222,15 @@
 "MODALITY_UNSPECIFIED",
 "CHAT_AND_VOICE",
 "VOICE_ONLY",
-"CHAT_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 only chat input.",
+"Widget supports chat, voice, and video input."
 ],
 "type": "string"
 },
@@ -3239,6 +3293,10 @@
 "$ref": "AgentTransfer",
 "description": "Optional. Agent transfer event."
 },
+"blob": {
+"$ref": "Blob",
+"description": "Optional. Blob data."
+},
 "defaultVariables": {
 "additionalProperties": {
 "description": "Properties of the object.",
@@ -4002,7 +4060,7 @@
 "id": "Deployment",
 "properties": {
 "appVersion": {
-"description": "Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}",
+"description": "Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.",
 "type": "string"
 },
 "channelProfile": {
@@ -4025,7 +4083,7 @@
 "type": "string"
 },
 "name": {
-"description": "Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}",
+"description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`",
 "type": "string"
 },
 "updateTime": {
@@ -4103,6 +4161,57 @@
 },
 "type": "object"
 },
+"EndpointControlPolicy": {
+"description": "Defines project/location level endpoint control policy.",
+"id": "EndpointControlPolicy",
+"properties": {
+"allowedOrigins": {
+"description": "Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, \"https://example.com\" will match \"https://example.com:443\" and any other port. \"https://example.com:443\" will only match \"https://example.com:443\".",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"enforcementScope": {
+"description": "Optional. The scope in which this policy's allowed_origins list is enforced.",
+"enum": [
+"ENFORCEMENT_SCOPE_UNSPECIFIED",
+"VPCSC_ONLY",
+"ALWAYS"
+],
+"enumDescriptions": [
+"Unspecified. This policy will be treated as VPCSC_ONLY.",
+"This policy applies only when VPC-SC is active.",
+"This policy ALWAYS applies, regardless of VPC-SC status."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"ErrorHandlingSettings": {
+"description": "Settings to describe how errors should be handled in the app.",
+"id": "ErrorHandlingSettings",
+"properties": {
+"errorHandlingStrategy": {
+"description": "Optional. The strategy to use for error handling.",
+"enum": [
+"ERROR_HANDLING_STRATEGY_UNSPECIFIED",
+"NONE",
+"FALLBACK_RESPONSE",
+"END_SESSION"
+],
+"enumDescriptions": [
+"Unspecified error handling strategy.",
+"No specific handling is enabled.",
+"A fallback message will be returned to the user in case of system errors (e.g. LLM errors).",
+"An EndSession signal will be emitted in case of system errors (e.g. LLM errors)."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "EvaluationMetricsThresholds": {
 "description": "Threshold settings for metrics in an Evaluation.",
 "id": "EvaluationMetricsThresholds",
@@ -4314,6 +4423,14 @@
 "description": "Optional. The input parameters and values for the tool in JSON object format.",
 "type": "object"
 },
+"context": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool.",
+"type": "object"
+},
 "tool": {
 "description": "Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}",
 "type": "string"
@@ -4368,6 +4485,10 @@
 "description": "Request message for AgentService.ExportApp.",
 "id": "ExportAppRequest",
 "properties": {
+"appVersion": {
+"description": "Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`.",
+"type": "string"
+},
 "exportFormat": {
 "description": "Required. The format to export the app in.",
 "enum": [
@@ -4457,6 +4578,10 @@
 "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"
@@ -4956,7 +5081,8 @@
 "type": "boolean"
 },
 "fallbackAction": {
-"description": "Optional. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as \"escalate\" or \"exit\", which triggers an EndSession signal with corresponding metadata to terminate the conversation.",
+"deprecated": true,
+"description": "Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as \"escalate\" or \"exit\", which triggers an EndSession signal with corresponding metadata to terminate the conversation.",
 "type": "string"
 },
 "supportedLanguageCodes": {
@@ -5276,6 +5402,13 @@
 "$ref": "ApiAuthentication",
 "description": "Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication."
 },
+"customHeaders": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.",
+"type": "object"
+},
 "description": {
 "description": "Optional. The description of the MCP tool.",
 "type": "string"
@@ -5315,6 +5448,13 @@
 "$ref": "ApiAuthentication",
 "description": "Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication."
 },
+"customHeaders": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.",
+"type": "object"
+},
 "serverAddress": {
 "description": "Required. The address of the MCP server, for example, \"https://example.com/mcp/\". If the server is built with the MCP SDK, the url should be suffixed with \"/mcp/\". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.",
 "type": "string"
@@ -6029,6 +6169,38 @@
 },
 "type": "object"
 },
+"SecuritySettings": {
+"description": "Project/Location level security settings for CES.",
+"id": "SecuritySettings",
+"properties": {
+"createTime": {
+"description": "Output only. Create time of the security settings.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"endpointControlPolicy": {
+"$ref": "EndpointControlPolicy",
+"description": "Optional. Endpoint control related settings."
+},
+"etag": {
+"description": "Output only. Etag of the security settings.",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`",
+"type": "string"
+},
+"updateTime": {
+"description": "Output only. Last update time of the security settings.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "ServiceAccountAuthConfig": {
 "description": "Configurations for authentication using a custom service account.",
 "id": "ServiceAccountAuthConfig",
@@ -6072,8 +6244,12 @@
 "description": "Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`",
 "type": "string"
 },
+"enableTextStreaming": {
+"description": "Optional. Whether to enable streaming text outputs from the model. By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession.",
+"type": "boolean"
+},
 "entryAgent": {
-"description": "Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/agents/{agent}`",
+"description": "Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
 "type": "string"
 },
 "historicalContexts": {
@@ -6098,6 +6274,10 @@
 "timeZone": {
 "description": "Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. \"America/Los_Angeles\".",
 "type": "string"
+},
+"useToolFakes": {
+"description": "Optional. Whether to use tool fakes for the session. If this field is set, the agent will attempt use tool fakes instead of calling the real tools.",
+"type": "boolean"
 }
 },
 "type": "object"
@@ -6387,7 +6567,7 @@
 "id": "TlsConfigCaCert",
 "properties": {
 "cert": {
-"description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\")",
+"description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```",
 "format": "byte",
 "type": "string"
 },
@@ -6402,6 +6582,10 @@
 "description": "A tool represents an action that the CES agent can take to achieve certain goals.",
 "id": "Tool",
 "properties": {
+"agentTool": {
+"$ref": "AgentTool",
+"description": "Optional. The agent tool."
+},
 "clientFunction": {
 "$ref": "ClientFunction",
 "description": "Optional. The client function."
@@ -6461,7 +6645,7 @@
 "description": "Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset."
 },
 "name": {
-"description": "Identifier. The unique identifier 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.",
+"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": {
@@ -6828,6 +7012,10 @@
 "description": "Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.",
 "id": "WidgetTool",
 "properties": {
+"dataMapping": {
+"$ref": "WidgetToolDataMapping",
+"description": "Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters."
+},
 "description": {
 "description": "Optional. The description of the widget tool.",
 "type": "string"
@@ -6840,6 +7028,14 @@
 "$ref": "Schema",
 "description": "Optional. The input parameters of the widget tool."
 },
+"uiConfig": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Configuration for rendering the widget.",
+"type": "object"
+},
 "widgetType": {
 "description": "Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.",
 "enum": [
@@ -6876,6 +7072,47 @@
 }
 },
 "type": "object"
+},
+"WidgetToolDataMapping": {
+"description": "Configuration for mapping data from a source tool to the widget's input parameters.",
+"id": "WidgetToolDataMapping",
+"properties": {
+"fieldMappings": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.",
+"type": "object"
+},
+"mode": {
+"description": "Optional. The mode of the data mapping.",
+"enum": [
+"MODE_UNSPECIFIED",
+"FIELD_MAPPING",
+"PYTHON_SCRIPT"
+],
+"enumDescriptions": [
+"Unspecified mode.",
+"Use the `field_mappings` map for data transformation.",
+"Use the `python_script` for data transformation."
+],
+"type": "string"
+},
+"pythonFunction": {
+"$ref": "PythonFunction",
+"description": "Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format."
+},
+"pythonScript": {
+"deprecated": true,
+"description": "Deprecated: Use `python_function` instead.",
+"type": "string"
+},
+"sourceToolName": {
+"description": "Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`",
+"type": "string"
+}
+},
+"type": "object"
 }
 },
 "servicePath": "",