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

googleapiclient/discovery_cache/documents/ces.v1.json

@@ -151,7 +151,7 @@
 ]
 },
 "list": {
-"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.",
+"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",
@@ -160,7 +160,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -806,13 +806,15 @@
 "SOURCE_UNSPECIFIED",
 "LIVE",
 "SIMULATOR",
-"EVAL"
+"EVAL",
+"AGENT_TOOL"
 ],
 "enumDescriptions": [
 "Unspecified source.",
 "The conversation is from the live end user.",
 "The conversation is from the simulator.",
-"The conversation is from the evaluation."
+"The conversation is from the evaluation.",
+"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes."
 ],
 "location": "query",
 "type": "string"
@@ -850,13 +852,15 @@
 "SOURCE_UNSPECIFIED",
 "LIVE",
 "SIMULATOR",
-"EVAL"
+"EVAL",
+"AGENT_TOOL"
 ],
 "enumDescriptions": [
 "Unspecified source.",
 "The conversation is from the live end user.",
 "The conversation is from the simulator.",
-"The conversation is from the evaluation."
+"The conversation is from the evaluation.",
+"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes."
 ],
 "location": "query",
 "type": "string"
@@ -909,13 +913,15 @@
 "SOURCE_UNSPECIFIED",
 "LIVE",
 "SIMULATOR",
-"EVAL"
+"EVAL",
+"AGENT_TOOL"
 ],
 "enumDescriptions": [
 "Unspecified source.",
 "The conversation is from the live end user.",
 "The conversation is from the simulator.",
-"The conversation is from the evaluation."
+"The conversation is from the evaluation.",
+"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes."
 ],
 "location": "query",
 "type": "string"
@@ -926,13 +932,15 @@
 "SOURCE_UNSPECIFIED",
 "LIVE",
 "SIMULATOR",
-"EVAL"
+"EVAL",
+"AGENT_TOOL"
 ],
 "enumDescriptions": [
 "Unspecified source.",
 "The conversation is from the live end user.",
 "The conversation is from the simulator.",
-"The conversation is from the evaluation."
+"The conversation is from the evaluation.",
+"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes."
 ],
 "location": "query",
 "repeated": true,
@@ -2275,7 +2283,7 @@
 }
 }
 },
-"revision": "20260325",
+"revision": "20260422",
 "rootUrl": "https://ces.googleapis.com/",
 "schemas": {
 "Action": {
@@ -2536,6 +2544,10 @@
 "description": "Represents a tool that allows the agent to call another agent.",
 "id": "AgentTool",
 "properties": {
+"agent": {
+"description": "Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`",
+"type": "string"
+},
 "description": {
 "description": "Optional. Description of the tool's purpose.",
 "type": "string"
@@ -2545,7 +2557,8 @@
 "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}`",
+"deprecated": true,
+"description": "Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`",
 "type": "string"
 }
 },
@@ -3538,6 +3551,7 @@
 "enum": [
 "INPUT_TYPE_UNSPECIFIED",
 "INPUT_TYPE_TEXT",
+"INPUT_TYPE_EVENT",
 "INPUT_TYPE_AUDIO",
 "INPUT_TYPE_IMAGE",
 "INPUT_TYPE_BLOB",
@@ -3546,12 +3560,13 @@
 ],
 "enumDescriptions": [
 "Unspecified input type.",
-"The input message is text.",
-"The input message is audio.",
-"The input message is image.",
-"The input message is blob file.",
-"The input message is client function tool response.",
-"The input message are variables."
+"Text input.",
+"Event input.",
+"Audio input.",
+"Image input.",
+"Blob input.",
+"Client function tool response input.",
+"Variables input."
 ],
 "type": "string"
 },
@@ -3581,13 +3596,15 @@
 "SOURCE_UNSPECIFIED",
 "LIVE",
 "SIMULATOR",
-"EVAL"
+"EVAL",
+"AGENT_TOOL"
 ],
 "enumDescriptions": [
 "Unspecified source.",
 "The conversation is from the live end user.",
 "The conversation is from the simulator.",
-"The conversation is from the evaluation."
+"The conversation is from 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"
@@ -3621,6 +3638,11 @@
 "disableConversationLogging": {
 "description": "Optional. Whether to disable conversation logging for the sessions.",
 "type": "boolean"
+},
+"retentionWindow": {
+"description": "Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days.",
+"format": "google-duration",
+"type": "string"
 }
 },
 "type": "object"
@@ -4082,6 +4104,10 @@
 "readOnly": true,
 "type": "string"
 },
+"experimentConfig": {
+"$ref": "ExperimentConfig",
+"description": "Optional. Experiment configuration for the deployment."
+},
 "name": {
 "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`",
 "type": "string"
@@ -4193,6 +4219,10 @@
 "description": "Settings to describe how errors should be handled in the app.",
 "id": "ErrorHandlingSettings",
 "properties": {
+"endSessionConfig": {
+"$ref": "ErrorHandlingSettingsEndSessionConfig",
+"description": "Optional. Configuration for ending the session in case of system errors (e.g. LLM errors)."
+},
 "errorHandlingStrategy": {
 "description": "Optional. The strategy to use for error handling.",
 "enum": [
@@ -4208,6 +4238,40 @@
 "An EndSession signal will be emitted in case of system errors (e.g. LLM errors)."
 ],
 "type": "string"
+},
+"fallbackResponseConfig": {
+"$ref": "ErrorHandlingSettingsFallbackResponseConfig",
+"description": "Optional. Configuration for handling fallback responses."
+}
+},
+"type": "object"
+},
+"ErrorHandlingSettingsEndSessionConfig": {
+"description": "Configuration for ending the session in case of system errors (e.g. LLM errors).",
+"id": "ErrorHandlingSettingsEndSessionConfig",
+"properties": {
+"escalateSession": {
+"description": "Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"ErrorHandlingSettingsFallbackResponseConfig": {
+"description": "Configuration for handling fallback responses.",
+"id": "ErrorHandlingSettingsFallbackResponseConfig",
+"properties": {
+"customFallbackMessages": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language).",
+"type": "object"
+},
+"maxFallbackAttempts": {
+"description": "Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.",
+"format": "int32",
+"type": "integer"
 }
 },
 "type": "object"
@@ -4431,6 +4495,10 @@
 "description": "Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool.",
 "type": "object"
 },
+"mockConfig": {
+"$ref": "MockConfig",
+"description": "Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses."
+},
 "tool": {
 "description": "Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}",
 "type": "string"
@@ -4481,6 +4549,69 @@
 },
 "type": "object"
 },
+"ExperimentConfig": {
+"description": "Experiment for the deployment.",
+"id": "ExperimentConfig",
+"properties": {
+"versionRelease": {
+"$ref": "ExperimentConfigVersionRelease",
+"description": "Optional. Version release for the experiment."
+}
+},
+"type": "object"
+},
+"ExperimentConfigVersionRelease": {
+"description": "Version release for the experiment.",
+"id": "ExperimentConfigVersionRelease",
+"properties": {
+"state": {
+"description": "Optional. State of the version release.",
+"enum": [
+"STATE_UNSPECIFIED",
+"PENDING",
+"RUNNING",
+"DONE",
+"EXPIRED"
+],
+"enumDescriptions": [
+"Unspecified state.",
+"Pending state. Experiment is pending and not valid.",
+"Running state. Experiment is running and valid.",
+"Done state. Experiment is done and no longer valid.",
+"Expired state. Experiment is expired and no longer valid."
+],
+"type": "string"
+},
+"trafficAllocations": {
+"description": "Optional. Traffic allocations for the version release.",
+"items": {
+"$ref": "ExperimentConfigVersionReleaseTrafficAllocation"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"ExperimentConfigVersionReleaseTrafficAllocation": {
+"description": "Traffic allocation for the version release.",
+"id": "ExperimentConfigVersionReleaseTrafficAllocation",
+"properties": {
+"appVersion": {
+"description": "Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`",
+"type": "string"
+},
+"id": {
+"description": "Optional. Id of the traffic allocation. Free format string, up to 128 characters.",
+"type": "string"
+},
+"trafficPercentage": {
+"description": "Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "ExportAppRequest": {
 "description": "Request message for AgentService.ExportApp.",
 "id": "ExportAppRequest",
@@ -5390,6 +5521,10 @@
 "redactionConfig": {
 "$ref": "RedactionConfig",
 "description": "Optional. Configuration for how sensitive data should be redacted."
+},
+"unredactedAudioRecordingConfig": {
+"$ref": "AudioRecordingConfig",
+"description": "Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes."
 }
 },
 "type": "object"
@@ -5504,6 +5639,70 @@
 },
 "type": "object"
 },
+"MockConfig": {
+"description": "Mock tool calls configuration for the session.",
+"id": "MockConfig",
+"properties": {
+"mockedToolCalls": {
+"description": "Optional. All tool calls to mock for the duration of the session.",
+"items": {
+"$ref": "MockedToolCall"
+},
+"type": "array"
+},
+"unmatchedToolCallBehavior": {
+"description": "Required. Beavhior for tool calls that don't match any args patterns in mocked_tool_calls.",
+"enum": [
+"UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED",
+"FAIL",
+"PASS_THROUGH"
+],
+"enumDescriptions": [
+"Default value. This value is unused.",
+"Throw an error for any tool calls that don't match a mock expected input pattern.",
+"For unmatched tool calls, pass the tool call through to real tool."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"MockedToolCall": {
+"description": "A mocked tool call. Expresses the target tool + a pattern to match against that tool's args / inputs. If the pattern matches, then the mock response will be returned.",
+"id": "MockedToolCall",
+"properties": {
+"expectedArgsPattern": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Required. A pattern to match against the args / inputs of all dispatched tool calls. If the tool call inputs match this pattern, then mock output will be returned.",
+"type": "object"
+},
+"mockResponse": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. The mock response / output to return if the tool call args / inputs match the pattern.",
+"type": "object"
+},
+"tool": {
+"deprecated": true,
+"description": "Optional. Deprecated. Use tool_identifier instead.",
+"type": "string"
+},
+"toolId": {
+"description": "Optional. The name of the tool to mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`",
+"type": "string"
+},
+"toolset": {
+"$ref": "ToolsetTool",
+"description": "Optional. The toolset to mock."
+}
+},
+"type": "object"
+},
 "ModelSettings": {
 "description": "Model settings contains various configurations for the LLM model.",
 "id": "ModelSettings",
@@ -7028,6 +7227,10 @@
 "$ref": "Schema",
 "description": "Optional. The input parameters of the widget tool."
 },
+"textResponseConfig": {
+"$ref": "WidgetToolTextResponseConfig",
+"description": "Optional. Configuration for always-included text responses."
+},
 "uiConfig": {
 "additionalProperties": {
 "description": "Properties of the object.",
@@ -7113,6 +7316,37 @@
 }
 },
 "type": "object"
+},
+"WidgetToolTextResponseConfig": {
+"description": "Configuration for the text response returned with the widget.",
+"id": "WidgetToolTextResponseConfig",
+"properties": {
+"staticText": {
+"description": "Optional. The static text response to return when type is STATIC.",
+"type": "string"
+},
+"textResponseInstruction": {
+"description": "Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.",
+"type": "string"
+},
+"type": {
+"description": "Optional. The strategy for providing the text response.",
+"enum": [
+"TYPE_UNSPECIFIED",
+"NONE",
+"LLM_GENERATED",
+"STATIC"
+],
+"enumDescriptions": [
+"Unspecified type.",
+"The LLM dynamically decides whether to generate a text response alongside the widget based on the conversation context.",
+"The LLM is explicitly required to generate a text response.",
+"A pre-defined static text response is always used."
+],
+"type": "string"
+}
+},
+"type": "object"
 }
 },
 "servicePath": "",