{ "auth": { "oauth2": { "scopes": { "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." }, "https://www.googleapis.com/auth/ces": { "description": "Create, update, delete, and manage your Next Gen Agents" } } } }, "canonicalName": "Customer Engagement Suite", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "mtlsRootUrl": "https://ces.mtls.googleapis.com/", "rootUrl": "https://ces.googleapis.com/", "ownerDomain": "google.com", "name": "ces", "discoveryVersion": "v1", "fullyEncodeReservedExpansion": true, "revision": "20260925", "servicePath": "", "baseUrl": "https://ces.googleapis.com/", "title": "Gemini Enterprise for Customer Experience API", "schemas": { "AssistantSessionArtifact": { "description": "A document artifact generated by the assistant within a session, stored as a file in the customer's Cloud Storage bucket.", "type": "object", "properties": { "id": { "description": "Output only. The unique identifier of the artifact within the session.", "type": "string", "readOnly": true }, "turnIndex": { "readOnly": true, "type": "integer", "description": "Output only. Index of the message in [AssistantSession.messages] whose turn produced the artifact, for placing the artifact chip when history is restored.", "format": "int32" }, "mimeType": { "type": "string", "description": "Output only. The IANA media type of the artifact content, e.g. \"text/markdown\".", "readOnly": true }, "displayName": { "description": "Output only. The file name shown to the user, e.g. \"hotel_booking_tdd.md\".", "type": "string", "readOnly": true }, "gcsUri": { "description": "Output only. The Cloud Storage object holding the artifact content. Example: \"gs://{project}-agent-assist-artifacts/agent-assist-generated/1_tdd.md\"", "type": "string", "readOnly": true }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. When the artifact was persisted.", "readOnly": true } }, "id": "AssistantSessionArtifact" }, "AgentInterface": { "id": "AgentInterface", "properties": { "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" }, "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" }, "tenant": { "type": "string", "description": "Tenant ID to be used in the request when calling the agent." }, "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" } }, "type": "object", "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." }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds": { "description": "Settings for golden evaluations.", "properties": { "turnLevelMetricsThresholds": { "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds", "description": "Optional. The turn level metrics thresholds." }, "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" }, "expectationLevelMetricsThresholds": { "description": "Optional. The expectation level metrics thresholds.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds" } }, "type": "object", "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds" }, "RunSessionRequest": { "type": "object", "description": "Request message for SessionService.RunSession.", "properties": { "inputs": { "type": "array", "items": { "$ref": "SessionInput" }, "description": "Required. Inputs for the session." }, "config": { "description": "Required. The configuration for the session.", "$ref": "SessionConfig" } }, "id": "RunSessionRequest" }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds": { "description": "Turn level metrics thresholds.", "type": "object", "properties": { "semanticSimilaritySuccessThreshold": { "format": "int32", "type": "integer", "description": "Optional. The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is \u003e= 3." }, "semanticSimilarityChannel": { "type": "string", "enum": [ "SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED", "TEXT", "AUDIO" ], "enumDescriptions": [ "Metric unspecified. Defaults to TEXT.", "Use text semantic similarity.", "Use audio semantic similarity." ], "description": "Optional. The semantic similarity channel to use for evaluation." }, "overallToolInvocationCorrectnessThreshold": { "format": "float", "description": "Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.", "type": "number" } }, "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds" }, "ChatAiAssistantResponse": { "type": "object", "description": "Response message for AssistantService.ChatAiAssistant.", "properties": { "statusMessage": { "type": "string", "description": "Simple status update" }, "eventId": { "type": "string", "description": "Unique identifier for the event." }, "uiEvent": { "description": "Optional. UI event payload.", "$ref": "UiEvent" }, "sessionCheckpoint": { "description": "Session checkpoint/compaction recap event containing user intent and rolling summary.", "$ref": "SessionCheckpoint" }, "textChunk": { "description": "Text Token (for streaming Gemini responses word-by-word)", "type": "string" }, "eventTime": { "type": "string", "description": "Timestamp when the event occurred.", "format": "google-datetime" } }, "id": "ChatAiAssistantResponse" }, "AggregatedMetricsMetricsByTurn": { "properties": { "turnLatencyMetrics": { "description": "Output only. Metrics for turn latency within this turn.", "items": { "$ref": "AggregatedMetricsTurnLatencyMetrics" }, "type": "array", "readOnly": true }, "toolMetrics": { "description": "Output only. Metrics for each tool within this turn.", "type": "array", "items": { "$ref": "AggregatedMetricsToolMetrics" }, "readOnly": true }, "hallucinationMetrics": { "items": { "$ref": "AggregatedMetricsHallucinationMetrics" }, "readOnly": true, "description": "Output only. Metrics for hallucination within this turn.", "type": "array" }, "semanticSimilarityMetrics": { "readOnly": true, "type": "array", "items": { "$ref": "AggregatedMetricsSemanticSimilarityMetrics" }, "description": "Output only. Metrics for semantic similarity within this turn." }, "toolCallLatencyMetrics": { "readOnly": true, "items": { "$ref": "AggregatedMetricsToolCallLatencyMetrics" }, "description": "Output only. Metrics for tool call latency within this turn.", "type": "array" }, "turnIndex": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The turn index (0-based)." } }, "description": "Metrics aggregated per turn.", "type": "object", "id": "AggregatedMetricsMetricsByTurn" }, "TransferRuleDeterministicTransfer": { "type": "object", "properties": { "pythonCodeCondition": { "$ref": "PythonCodeCondition", "description": "Optional. A rule that uses Python code block to evaluate the conditions. If the condition evaluates to true, the transfer occurs." }, "expressionCondition": { "$ref": "ExpressionCondition", "description": "Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs." } }, "description": "Deterministic transfer rule. When the condition evaluates to true, the transfer occurs.", "id": "TransferRuleDeterministicTransfer" }, "QualityReportIssue": { "type": "object", "properties": { "description": { "description": "Optional. Description of the issue found.", "type": "string" }, "proposedSolution": { "type": "string", "description": "Optional. Proposed solution to fix the issue by modifying instructions or tools." }, "occurrenceCount": { "type": "integer", "format": "int32", "description": "Optional. How many times this issue occurred." } }, "description": "The issue identified.", "id": "QualityReportIssue" }, "ListExamplesResponse": { "id": "ListExamplesResponse", "properties": { "examples": { "type": "array", "items": { "$ref": "Example" }, "description": "The list of examples." }, "nextPageToken": { "type": "string", "description": "A token that can be sent as ListExamplesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages." } }, "description": "Response message for AgentService.ListExamples.", "type": "object" }, "AgentRemoteDialogflowAgent": { "type": "object", "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.", "properties": { "inputVariableMapping": { "description": "Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.", "additionalProperties": { "type": "string" }, "type": "object" }, "languageCodeVariable": { "type": "string", "description": "Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used." }, "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" }, "agent": { "type": "string", "description": "Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`" }, "outputVariableMapping": { "description": "Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.", "type": "object", "additionalProperties": { "type": "string" } }, "flowId": { "description": "Optional. The flow ID of the flow in the Dialogflow agent.", "type": "string" } }, "id": "AgentRemoteDialogflowAgent" }, "DataStoreToolSnippetsConfig": { "properties": { "enableSnippets": { "description": "Optional. Whether snippets are enabled.", "type": "boolean" }, "maxSnippets": { "type": "integer", "format": "int32", "description": "Optional. Number of snippets to return per query. If unset, returns all snippets from the service by default." } }, "description": "Snippets configuration.", "type": "object", "id": "DataStoreToolSnippetsConfig" }, "Event": { "properties": { "variables": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. Additional variables associated with the event." }, "event": { "description": "Required. The name of the event.", "type": "string" } }, "type": "object", "description": "Event input.", "id": "Event" }, "EvaluationRunEvaluationRunSummary": { "properties": { "errorCount": { "description": "Output only. Number of error results for the associated Evaluation in this run.", "format": "int32", "type": "integer", "readOnly": true }, "failedCount": { "readOnly": true, "description": "Output only. Number of failed results for the associated Evaluation in this run.", "type": "integer", "format": "int32" }, "passedCount": { "readOnly": true, "description": "Output only. Number of passed results for the associated Evaluation in this run.", "format": "int32", "type": "integer" } }, "id": "EvaluationRunEvaluationRunSummary", "description": "Contains the summary of passed and failed result counts for a specific evaluation in an evaluation run.", "type": "object" }, "CitationsInlineCitation": { "id": "CitationsInlineCitation", "type": "object", "properties": { "startIndex": { "type": "integer", "format": "int32", "description": "The starting index (in bytes) of the text segment in the agent response." }, "citedChunkIndices": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The indices of the cited chunks that back this text segment. Indices refer to the elements in `cited_chunks`." }, "endIndex": { "type": "integer", "format": "int32", "description": "The ending index (in bytes) of the text segment in the agent response." } }, "description": "An inline citation in the response text." }, "ServiceAccountAuthConfig": { "description": "Configurations for authentication using a custom service account.", "properties": { "serviceAccount": { "description": "Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.", "type": "string" }, "scopes": { "type": "array", "description": "Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.", "items": { "type": "string" } } }, "id": "ServiceAccountAuthConfig", "type": "object" }, "UserResponseSuggestions": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "type": "string" }, "description": "Required. The assistant suggested user responses. These are suggestions for the user on how to interact with the assistant." } }, "description": "Suggested user responses from the assistant agent.", "id": "UserResponseSuggestions" }, "EndUserAuthConfigOauth2JwtBearerConfig": { "type": "object", "properties": { "subject": { "type": "string", "description": "Required. Subject parameter name to pass through. Must be in the format `$context.variables.`." }, "clientKey": { "description": "Required. Client parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" }, "issuer": { "description": "Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.", "type": "string" } }, "id": "EndUserAuthConfigOauth2JwtBearerConfig", "description": "JWT Profile Oauth 2.0 Authorization Grant authentication configuration." }, "GuardrailCodeCallback": { "properties": { "afterAgentCallback": { "$ref": "Callback", "description": "Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing." }, "beforeAgentCallback": { "$ref": "Callback", "description": "Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing." }, "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" }, "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" } }, "type": "object", "description": "Guardrail that blocks the conversation based on the code callbacks provided.", "id": "GuardrailCodeCallback" }, "ArtifactChunk": { "properties": { "contentDelta": { "type": "string", "description": "Incremental artifact content. Set on DELTA chunks." }, "displayName": { "type": "string", "description": "The file name shown to the user, e.g. \"hotel_booking_tdd.md\". Set on STARTED (and repeated on FINALIZED)." }, "state": { "description": "Lifecycle position of this chunk.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "STARTED", "DELTA", "FINALIZED", "FAILED", "CLOSED" ], "enumDescriptions": [ "Unused default.", "The assistant started generating the artifact.", "A content increment; content_delta is set.", "The artifact was persisted; gcs_uri is set.", "Generation or persistence failed; the artifact was not saved.", "The document finished streaming: its content was fully delivered via content_delta chunks. Persistence may still follow; a FINALIZED chunk with a gcs_uri is sent if and when the artifact is saved." ] }, "gcsUri": { "description": "The GCS object the artifact was persisted to. Set on FINALIZED chunks.", "type": "string" }, "artifactId": { "description": "Identifier of the artifact, stable across all chunks of one artifact within the stream.", "type": "string" }, "mimeType": { "description": "The IANA media type of the artifact content, e.g. \"text/markdown\".", "type": "string" } }, "type": "object", "description": "A streamed fragment of a document artifact (e.g. a markdown TDD) that the assistant is generating. Content deltas stream while the document is being written so clients can render a live preview; the FINALIZED chunk carries the GCS URI once the file has been persisted.", "id": "ArtifactChunk" }, "GenerateAppResourceRequestAppVersionContext": { "type": "object", "id": "GenerateAppResourceRequestAppVersionContext", "description": "The app version context specifying the base snapshot and target agent.", "properties": { "appVersion": { "description": "The resource name of the app version to be used by the LLM assistant. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "agentResourceName": { "description": "The resource name of the target agent to be used by the LLM assistant. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" } } }, "LfA2aV1AgentProvider": { "type": "object", "id": "LfA2aV1AgentProvider", "description": "Represents the service provider of an agent.", "properties": { "url": { "description": "Required. A URL for the agent provider's website or relevant documentation. Example: \"https://ai.google.dev\"", "type": "string" }, "organization": { "type": "string", "description": "Required. The name of the agent provider's organization. Example: \"Google\"" } } }, "McpToolDefinition": { "description": "Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden.", "id": "McpToolDefinition", "properties": { "description": { "description": "Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`.", "type": "string", "readOnly": true }, "inputSchema": { "description": "Output only. The schema of the input arguments of the MCP tool.", "readOnly": true, "$ref": "Schema" }, "outputSchema": { "$ref": "Schema", "description": "Output only. The schema of the output arguments of the MCP tool.", "readOnly": true } }, "type": "object" }, "BargeInConfig": { "description": "Configuration for how the user barge-in activities should be handled.", "properties": { "bargeInAwareness": { "description": "Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.", "type": "boolean" }, "disableBargeIn": { "deprecated": true, "description": "Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.", "type": "boolean" } }, "id": "BargeInConfig", "type": "object" }, "PythonFunction": { "description": "A Python function tool.", "type": "object", "id": "PythonFunction", "properties": { "pythonCode": { "description": "Optional. The Python code to execute for the tool.", "type": "string" }, "description": { "type": "string", "description": "Output only. The description of the Python function, parsed from the python code's docstring.", "readOnly": true }, "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" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration for the tool.", "$ref": "ServiceDirectoryConfig" } } }, "BatchDeleteConversationsRequest": { "id": "BatchDeleteConversationsRequest", "description": "Request message for AgentService.BatchDeleteConversations.", "properties": { "conversations": { "items": { "type": "string" }, "description": "Required. The resource names of the conversations to delete.", "type": "array" } }, "type": "object" }, "EvaluationResultScenarioResult": { "properties": { "rubricOutcomes": { "type": "array", "items": { "$ref": "EvaluationResultScenarioRubricOutcome" }, "readOnly": true, "description": "Output only. The outcome of the rubric." }, "evaluationExpectationResults": { "type": "array", "readOnly": true, "items": { "$ref": "EvaluationResultEvaluationExpectationResult" }, "description": "Output only. The results of the evaluation expectations." }, "spanLatencies": { "type": "array", "items": { "$ref": "EvaluationResultSpanLatency" }, "description": "Output only. The latency of spans in the conversation.", "readOnly": true }, "taskCompletionResult": { "description": "Output only. The result of the task completion check.", "readOnly": true, "deprecated": true, "$ref": "EvaluationResultTaskCompletionResult" }, "taskCompleted": { "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.", "readOnly": true }, "conversation": { "readOnly": true, "description": "Output only. The conversation that was generated in the scenario.", "type": "string" }, "allExpectationsSatisfied": { "description": "Output only. Whether all expectations were satisfied for this turn.", "readOnly": true, "type": "boolean" }, "toolCallLatencies": { "readOnly": true, "items": { "$ref": "EvaluationResultToolCallLatency" }, "type": "array", "description": "Output only. The latency of each tool call execution in the conversation." }, "hallucinationResult": { "readOnly": true, "type": "array", "items": { "$ref": "EvaluationResultHallucinationResult" }, "description": "Output only. The result of the hallucination check. There will be one hallucination result for each turn in the conversation." }, "task": { "readOnly": true, "description": "Output only. The task that was used when running the scenario for this result.", "type": "string" }, "expectationOutcomes": { "description": "Output only. The outcome of each expectation.", "items": { "$ref": "EvaluationResultScenarioExpectationOutcome" }, "type": "array", "readOnly": true }, "userFacts": { "type": "array", "readOnly": true, "description": "Output only. The user facts that were used by the scenario for this result.", "items": { "$ref": "EvaluationScenarioUserFact" } }, "userGoalSatisfactionResult": { "readOnly": true, "$ref": "EvaluationResultUserGoalSatisfactionResult", "description": "Output only. The result of the user goal satisfaction check." } }, "description": "The outcome of a scenario evaluation.", "id": "EvaluationResultScenarioResult", "type": "object" }, "AggregatedMetricsToolCallLatencyMetrics": { "description": "Metrics for tool call latency.", "properties": { "tool": { "readOnly": true, "type": "string", "description": "Output only. The name of the tool." }, "averageLatency": { "type": "string", "readOnly": true, "description": "Output only. The average latency of the tool calls.", "format": "google-duration" } }, "id": "AggregatedMetricsToolCallLatencyMetrics", "type": "object" }, "ListToolsResponse": { "type": "object", "properties": { "tools": { "type": "array", "items": { "$ref": "Tool" }, "description": "The list of tools." }, "nextPageToken": { "type": "string", "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." } }, "description": "Response message for AgentService.ListTools.", "id": "ListToolsResponse" }, "ImportEvaluationsRequestConversationList": { "type": "object", "properties": { "conversations": { "description": "Optional. Conversation resource names.", "items": { "type": "string" }, "type": "array" } }, "description": "A list of conversation resource names.", "id": "ImportEvaluationsRequestConversationList" }, "Blob": { "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" }, "data": { "type": "string", "format": "byte", "description": "Required. Raw bytes of the blob." } }, "description": "Represents a blob input or output in the conversation.", "id": "Blob", "type": "object" }, "LfA2aV1SendMessageConfiguration": { "id": "LfA2aV1SendMessageConfiguration", "description": "Configuration of a send message request.", "properties": { "acceptedOutputModes": { "type": "array", "description": "A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output.", "items": { "type": "string" } }, "historyLength": { "format": "int32", "description": "The maximum number of most recent messages from the task's history to retrieve in the response. An unset value means the client does not impose any limit. A value of zero is a request to not include any messages. The server MUST NOT return more messages than the provided value, but MAY apply a lower limit.", "type": "integer" }, "returnImmediately": { "description": "If `true`, the operation returns immediately after creating the task, even if processing is still in progress. If `false` (default), the operation MUST wait until the task reaches a terminal (`COMPLETED`, `FAILED`, `CANCELED`, `REJECTED`) or interrupted (`INPUT_REQUIRED`, `AUTH_REQUIRED`) state before returning.", "type": "boolean" }, "taskPushNotificationConfig": { "description": "Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request.", "$ref": "LfA2aV1TaskPushNotificationConfig" } }, "type": "object" }, "LfA2aV1AgentExtension": { "type": "object", "id": "LfA2aV1AgentExtension", "properties": { "description": { "description": "A human-readable description of how this agent uses the extension.", "type": "string" }, "params": { "type": "object", "description": "Optional. Extension-specific configuration parameters.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "required": { "type": "boolean", "description": "If true, the client must understand and comply with the extension's requirements." }, "uri": { "description": "The unique URI identifying the extension.", "type": "string" } }, "description": "A declaration of a protocol extension supported by an Agent." }, "TlsConfig": { "description": "The TLS configuration.", "type": "object", "properties": { "caCerts": { "type": "array", "items": { "$ref": "TlsConfigCaCert" }, "description": "Required. Specifies a list of allowed custom CA certificates for HTTPS verification." } }, "id": "TlsConfig" }, "EvaluationResultTaskCompletionResult": { "type": "object", "properties": { "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, "description": "Output only. The explanation for the task completion score.", "type": "string" }, "score": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The task completion score. Can be -1, 0, 1" } }, "id": "EvaluationResultTaskCompletionResult", "description": "The result of the task completion check for the conversation." }, "LatencyReportLatencyMetrics": { "description": "Latency metrics for a component.", "id": "LatencyReportLatencyMetrics", "properties": { "p50Latency": { "type": "string", "readOnly": true, "format": "google-duration", "description": "Output only. The 50th percentile latency." }, "p99Latency": { "type": "string", "readOnly": true, "description": "Output only. The 99th percentile latency.", "format": "google-duration" }, "callCount": { "format": "int32", "readOnly": true, "type": "integer", "description": "Output only. The number of times the resource was called." }, "p90Latency": { "readOnly": true, "format": "google-duration", "type": "string", "description": "Output only. The 90th percentile latency." } }, "type": "object" }, "EvaluationExpectationLlmCriteria": { "properties": { "prompt": { "type": "string", "description": "Required. The prompt/instructions provided to the LLM judge." } }, "id": "EvaluationExpectationLlmCriteria", "type": "object", "description": "Configuration for LLM-based evaluation criteria." }, "StreamChatAiAssistantRequest": { "description": "Request message for SessionService.StreamChatAiAssistant.", "properties": { "attachedGcsUris": { "items": { "type": "string" }, "type": "array", "description": "Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: \"gs://cxas-transient-uploads/uuid/prd.pdf\"" }, "operationCompletedEvent": { "$ref": "OperationCompletedEvent", "description": "Optional. Resumes an assistant session paused waiting for a client-managed long-running operation to complete." }, "contextToken": { "description": "Optional. Opaque onboarding context token returned by SessionService.GenerateOnboardingSuggestions. When set and still fresh, the server reuses the onboarding snapshot computed for the zero state instead of recomputing it for the first conversation turn.", "type": "string" }, "confirmationResponse": { "description": "Optional. The user's answer to a pending AssistantConfirmationRequest. When set, the server resumes the paused agent with this answer instead of (or in addition to) starting a new prompt turn.", "$ref": "AssistantConfirmationResponse" }, "clientCapabilities": { "items": { "enumDescriptions": [ "Unspecified capability; ignored.", "The client renders AssistantConfirmationRequest cards and answers them via `confirmation_response`.", "The client manages long-running operations out-of-band by polling the operation and sending `operation_completed_event` to resume the turn. If not declared, the server manages LRO polling and completes the turn inline." ], "type": "string", "enum": [ "CLIENT_CAPABILITY_UNSPECIFIED", "CONFIRMATION_CARDS", "CLIENT_MANAGED_LRO" ] }, "type": "array", "description": "Optional. Response features this client can render. The server only emits events that need a capability (e.g. `confirmation_request`) when the capability is declared, so older clients never receive events they would silently drop." }, "attachOnly": { "description": "Optional. Optional flag to attach to an existing in-flight turn without submitting a new message.", "type": "boolean" }, "resumeFromSequenceNumber": { "type": "string", "description": "Optional. Optional cursor to resume and replay events from an in-flight or completed turn.", "format": "int64" }, "message": { "description": "Optional. The message to send to the assistant agent. May be empty when `confirmation_response` is set (answering a pending confirmation without adding a new message); at least one of the two must be provided.", "type": "string" } }, "type": "object", "id": "StreamChatAiAssistantRequest" }, "ActiveTurnInfo": { "id": "ActiveTurnInfo", "properties": { "orphanDeadlineTime": { "format": "google-datetime", "type": "string", "description": "Output only. When the turn will be wound down if no client attaches.", "readOnly": true }, "turnId": { "description": "Identifies the turn; echoed by resume snapshots on the streaming API.", "type": "string" }, "lastProgressTime": { "readOnly": true, "description": "Output only. When the turn last persisted progress.", "type": "string", "format": "google-datetime" }, "status": { "enumDescriptions": [ "Unspecified.", "The turn is executing with at least one client attached.", "The turn is executing with no client attached.", "The turn is parked for pickup: the next attach continues it.", "The turn's server lease has lapsed and no task is driving it; the next read seals it to a committed partial. Not attachable." ], "description": "Current attachment status.", "type": "string", "enum": [ "STATUS_UNSPECIFIED", "RUNNING", "DISCONNECTED", "RESUMING", "ABANDONED" ] }, "startTime": { "description": "Output only. When the turn started.", "type": "string", "readOnly": true, "format": "google-datetime" } }, "type": "object", "description": "Live-attachment info for a session turn that is currently running, disconnected from its client, or parked for pickup by another server task." }, "RetrieveToolSchemaRequest": { "description": "Request message for ToolService.RetrieveToolSchema.", "type": "object", "id": "RetrieveToolSchemaRequest", "properties": { "tool": { "description": "Optional. The name of the tool to retrieve the schema for. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}", "type": "string" }, "toolsetTool": { "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" } } }, "Example": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Required. Display name of the example." }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when the example was created.", "type": "string", "readOnly": true }, "name": { "type": "string", "description": "Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`" }, "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" }, "messages": { "description": "Optional. The collection of messages that make up the conversation.", "type": "array", "items": { "$ref": "Message" } }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when the example was last updated.", "readOnly": true }, "invalid": { "description": "Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.", "type": "boolean", "readOnly": true }, "entryAgent": { "description": "Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "description": { "description": "Optional. Human-readable description of the example.", "type": "string" } }, "id": "Example", "description": "An example represents a sample conversation between the user and the agent(s)." }, "StreamChatAiAssistantResponse": { "description": "Response message for SessionService.StreamChatAiAssistant.", "properties": { "resumeSnapshot": { "description": "A compacted replay of an in-flight turn, sent as the first event of every attach or resume before any live event. The client replaces any locally rendered state for this turn with the snapshot's contents.", "$ref": "TurnResumeSnapshot" }, "sequenceNumber": { "type": "string", "description": "Optional. Monotonically increasing sequence number for this session turn.", "format": "int64" }, "confirmationRequest": { "description": "A blocking confirmation the agent paused on. The agent resumes when the answer arrives on a later request's `confirmation_response`. Only sent to clients that declared the CONFIRMATION_CARDS capability on the request.", "$ref": "AssistantConfirmationRequest" }, "textChunk": { "description": "Text Token (for streaming Gemini responses word-by-word).", "type": "string" }, "artifactChunk": { "description": "Generated-document artifact event (live preview deltas + final GCS pointer).", "$ref": "ArtifactChunk" }, "toolResponse": { "$ref": "ToolResponse", "description": "Tool call response event." }, "turnCompleted": { "description": "The turn has ended. Sent as the last event of every turn, on the original stream and on every attached or resumed stream, so clients can end the turn on an explicit signal instead of inferring it from stream closure.", "$ref": "TurnCompletedEvent" }, "optionQuestionsChunk": { "description": "Structured clarification options parsed out of the model turn. The console renders these as a selectable option list instead of raw text.", "$ref": "OptionQuestionsChunk" }, "eventTime": { "type": "string", "description": "Timestamp when the event occurred.", "format": "google-datetime" }, "sessionCheckpoint": { "$ref": "SessionCheckpoint", "description": "Session checkpoint/compaction recap event containing user intent and rolling summary." }, "uiEvent": { "description": "Optional. UI event payload.", "$ref": "UiEvent" }, "toolCall": { "description": "Tool call execution event.", "$ref": "ToolCall" }, "turnInProgress": { "description": "Optional. Indicates whether the turn is still actively running in the background.", "type": "boolean" }, "handoff": { "$ref": "TurnHandoffEvent", "description": "Tells the client to silently reconnect with resume_from_sequence_number: the task serving this stream is going away and the turn will continue elsewhere. Not an error; the stream completes normally after this event." }, "turnMetadata": { "$ref": "TurnMetadata", "description": "Optional. Turn-level metadata and intent categorization." }, "eventId": { "description": "Unique identifier for the event.", "type": "string" }, "status": { "description": "Simple status update.", "$ref": "Status" }, "thoughtChunk": { "type": "string", "description": "Thought text chunk (agent's reasoning before generating response)." } }, "type": "object", "id": "StreamChatAiAssistantResponse" }, "ExportAppResponse": { "properties": { "appContent": { "type": "string", "description": "App folder compressed as a zip file.", "format": "byte" }, "appUri": { "type": "string", "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which the app was exported." } }, "description": "Response message for AgentService.ExportApp.", "type": "object", "id": "ExportAppResponse" }, "UploadEvaluationAudioRequest": { "type": "object", "id": "UploadEvaluationAudioRequest", "properties": { "audioContent": { "description": "Required. The raw audio bytes. The format of the audio must be single-channel LINEAR16 with a sample rate of 16kHz (default InputAudioConfig).", "format": "byte", "type": "string" }, "previousAudioGcsUri": { "description": "Optional. The Google Cloud Storage URI of the previously uploaded audio file to be deleted. Format: `gs:///`", "type": "string" } }, "description": "Request message for EvaluationService.UploadEvaluationAudio." }, "EvaluationResultGoldenResult": { "type": "object", "description": "The result of a golden evaluation.", "id": "EvaluationResultGoldenResult", "properties": { "evaluationExpectationResults": { "type": "array", "description": "Output only. The results of the evaluation expectations.", "readOnly": true, "items": { "$ref": "EvaluationResultEvaluationExpectationResult" } }, "turnReplayResults": { "description": "Output only. The result of running each turn of the golden conversation.", "type": "array", "items": { "$ref": "EvaluationResultGoldenResultTurnReplayResult" }, "readOnly": true } } }, "EvaluationMetricsThresholdsToolMatchingSettings": { "properties": { "extraToolCallBehavior": { "type": "string", "enum": [ "EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED", "FAIL", "ALLOW" ], "description": "Optional. Behavior for extra tool calls. Defaults to FAIL.", "enumDescriptions": [ "Unspecified behavior. Defaults to FAIL.", "Fail the evaluation if an extra tool call is encountered.", "Allow the extra tool call." ] } }, "description": "Settings for matching tool calls.", "id": "EvaluationMetricsThresholdsToolMatchingSettings", "type": "object" }, "DataStoreToolBoostSpecConditionBoostSpec": { "type": "object", "id": "DataStoreToolBoostSpecConditionBoostSpec", "properties": { "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" }, "boostControlSpec": { "description": "Optional. Complex specification for custom ranking based on customer defined attribute value.", "$ref": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec" }, "boost": { "format": "float", "type": "number", "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." } }, "description": "Boost specification for a condition." }, "LfA2aV1PasswordOAuthFlow": { "id": "LfA2aV1PasswordOAuthFlow", "properties": { "tokenUrl": { "description": "The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" }, "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" }, "scopes": { "type": "object", "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.", "additionalProperties": { "type": "string" } } }, "description": "Deprecated: Use Authorization Code + PKCE or Device Code.", "type": "object" }, "ChannelProfileWebWidgetConfig": { "description": "Message for configuration for the web widget.", "properties": { "webWidgetTitle": { "type": "string", "description": "Optional. The title of the web widget." }, "theme": { "enumDescriptions": [ "Unknown theme.", "Light theme.", "Dark theme." ], "type": "string", "enum": [ "THEME_UNSPECIFIED", "LIGHT", "DARK" ], "description": "Optional. The theme of the web widget." }, "modality": { "type": "string", "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." ], "description": "Optional. The modality of the web widget." }, "securitySettings": { "description": "Optional. The security settings of the web widget.", "$ref": "ChannelProfileWebWidgetConfigSecuritySettings" } }, "id": "ChannelProfileWebWidgetConfig", "type": "object" }, "LatencyReportLlmCallLatency": { "properties": { "model": { "type": "string", "readOnly": true, "description": "Output only. The name of the model." }, "latencyMetrics": { "$ref": "LatencyReportLatencyMetrics", "readOnly": true, "description": "Output only. The latency metrics for the LLM call." } }, "type": "object", "id": "LatencyReportLlmCallLatency", "description": "Latency metrics for a single LLM call." }, "GenerateAppResourceRequestEvaluationPersonasGenerationConfig": { "type": "object", "properties": {}, "description": "The configuration to be used to generate the evaluation personas.", "id": "GenerateAppResourceRequestEvaluationPersonasGenerationConfig" }, "Chunk": { "properties": { "image": { "description": "Optional. Image data.", "$ref": "Image" }, "updatedVariables": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "A struct represents variables that were updated in the conversation, keyed by variable names." }, "payload": { "type": "object", "description": "Optional. Custom payload data.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "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." } }, "toolCall": { "description": "Optional. Tool execution request.", "$ref": "ToolCall" }, "blob": { "$ref": "Blob", "description": "Optional. Blob data." }, "transcript": { "description": "Optional. Transcript associated with the audio.", "type": "string" }, "text": { "description": "Optional. Text data.", "type": "string" }, "agentTransfer": { "description": "Optional. Agent transfer event.", "$ref": "AgentTransfer" }, "toolResponse": { "description": "Optional. Tool execution response.", "$ref": "ToolResponse" } }, "id": "Chunk", "description": "A chunk of content within a message.", "type": "object" }, "DataStoreToolModalityConfig": { "properties": { "snippetsConfig": { "$ref": "DataStoreToolSnippetsConfig", "description": "Optional. The snippets configuration." }, "groundingConfig": { "$ref": "DataStoreToolGroundingConfig", "description": "Optional. The grounding configuration." }, "summarizationConfig": { "$ref": "DataStoreToolSummarizationConfig", "description": "Optional. The summarization config." }, "modalityType": { "description": "Required. The modality type.", "enumDescriptions": [ "Unspecified modality type.", "Text modality.", "Audio modality." ], "type": "string", "enum": [ "MODALITY_TYPE_UNSPECIFIED", "TEXT", "AUDIO" ] }, "rewriterConfig": { "$ref": "DataStoreToolRewriterConfig", "description": "Optional. The rewriter config." } }, "description": "If specified, will apply the given configuration for the specified modality.", "type": "object", "id": "DataStoreToolModalityConfig" }, "AgentLlmAgent": { "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.", "type": "object", "properties": {} }, "ExportAppRequest": { "properties": { "exportFormat": { "type": "string", "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "description": "Required. The format to export the app in.", "enumDescriptions": [ "The export format is unspecified.", "The export format is JSON.", "The export format is YAML." ] }, "appVersion": { "description": "Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`.", "type": "string" }, "gcsUri": { "description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified GCS object.", "type": "string" } }, "type": "object", "id": "ExportAppRequest", "description": "Request message for AgentService.ExportApp." }, "ApiAuthentication": { "description": "Authentication information required for API calls.", "properties": { "serviceAgentIdTokenAuthConfig": { "$ref": "ServiceAgentIdTokenAuthConfig", "description": "Optional. Config for ID token auth generated from CES service agent." }, "bearerTokenConfig": { "$ref": "BearerTokenConfig", "description": "Optional. Config for bearer token auth." }, "oauthConfig": { "description": "Optional. Config for OAuth.", "$ref": "OAuthConfig" }, "apiKeyConfig": { "description": "Optional. Config for API key auth.", "$ref": "ApiKeyConfig" }, "serviceAccountAuthConfig": { "$ref": "ServiceAccountAuthConfig", "description": "Optional. Config for service account authentication." } }, "type": "object", "id": "ApiAuthentication" }, "EvaluationMetricsConfigUserGoalMetMetricsConfig": { "properties": { "enableUserGoalMetMetrics": { "description": "Optional. Whether to calculate the user goal met metrics for the evaluation.", "type": "boolean" } }, "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.", "type": "object", "id": "EvaluationMetricsConfigUserGoalMetMetricsConfig" }, "GenerateAppResourceResponseEvaluations": { "description": "The list of evaluations generated by the LLM assistant.", "id": "GenerateAppResourceResponseEvaluations", "type": "object", "properties": { "evaluations": { "description": "The list of generated evaluations.", "type": "array", "items": { "$ref": "Evaluation" } } } }, "EvaluationResultUserGoalSatisfactionResult": { "properties": { "explanation": { "description": "Output only. The explanation for the user task satisfaction score.", "readOnly": true, "type": "string" }, "score": { "type": "integer", "description": "Output only. The user task satisfaction score. Can be -1, 0, 1, 2.", "readOnly": true, "format": "int32" }, "label": { "readOnly": true, "type": "string", "description": "Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified" } }, "description": "The result of a user goal satisfaction check for a conversation.", "type": "object", "id": "EvaluationResultUserGoalSatisfactionResult" }, "ScheduledEvaluationRun": { "description": "Represents a scheduled evaluation run configuration.", "properties": { "totalExecutions": { "description": "Output only. The total number of times this run has been executed", "type": "integer", "format": "int32", "readOnly": true }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the scheduled evaluation run was created.", "format": "google-datetime" }, "createdBy": { "type": "string", "description": "Output only. The user who created the scheduled evaluation run.", "readOnly": true }, "nextScheduledExecutionTime": { "type": "string", "description": "Output only. The next time this is scheduled to execute", "readOnly": true, "format": "google-datetime" }, "name": { "description": "Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}", "type": "string" }, "active": { "description": "Optional. Whether this config is active", "type": "boolean" }, "schedulingConfig": { "description": "Required. Configuration for the timing and frequency with which to execute the evaluations.", "$ref": "ScheduledEvaluationRunSchedulingConfig" }, "lastCompletedRun": { "readOnly": true, "type": "string", "description": "Output only. The last successful EvaluationRun of this scheduled execution. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`" }, "description": { "description": "Optional. User-defined description of the scheduled evaluation run.", "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the evaluation was last updated.", "format": "google-datetime" }, "request": { "description": "Required. The RunEvaluationRequest to schedule", "$ref": "RunEvaluationRequest" }, "displayName": { "type": "string", "description": "Required. User-defined display name of the scheduled evaluation run config." }, "lastUpdatedBy": { "readOnly": true, "description": "Output only. The user who last updated the evaluation.", "type": "string" }, "etag": { "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.", "readOnly": true } }, "id": "ScheduledEvaluationRun", "type": "object" }, "AssistantConfirmationRequest": { "description": "A blocking question or confirmation the assistant needs answered before an agent action can proceed. The requesting agent is paused and resumes only when the answer arrives on a later StreamChatAiAssistantRequest.confirmation_response.", "properties": { "confirmationId": { "type": "string", "description": "Identifier correlating this request with its response. Opaque to clients; must be echoed verbatim on the answering request." }, "context": { "description": "Context describing what is being confirmed (e.g. the action the agent wants to take, or the question it needs answered). Rendered as plain text, not Markdown.", "type": "string" }, "negativeLabel": { "type": "string", "description": "Label for the declining action of a binary confirmation (e.g. \"Not yet\"). Unset when `questions` is populated." }, "questions": { "description": "Multi-choice form of the confirmation. When populated, the card renders a selectable option list and the chosen option's submit_text (or free-form user text) is returned as AssistantConfirmationResponse.answer_text.", "type": "array", "items": { "$ref": "OptionQuestionsChunkQuestion" } }, "positiveLabel": { "type": "string", "description": "Label for the approving action of a binary confirmation (e.g. \"Publish\"). Unset when `questions` is populated." }, "expireTime": { "format": "google-datetime", "type": "string", "description": "Time after which this confirmation can no longer be answered. An expired card renders as inactive, and the server declines the confirmation on the next turn so the paused agent does not wait indefinitely." }, "tool": { "description": "Name of the tool call the agent paused on (e.g. \"update_app\"), for the card header. Unset for pure questions.", "type": "string" }, "agentName": { "description": "Display label of the agent that raised the confirmation (e.g. `\"Contract Architect\"`), for the card header.", "type": "string" } }, "id": "AssistantConfirmationRequest", "type": "object" }, "AgentRemoteA2aAgent": { "id": "AgentRemoteA2aAgent", "type": "object", "properties": { "a2aConfig": { "description": "Required. The A2A connection configuration.", "$ref": "RemoteA2aConfig" } }, "description": "The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent." }, "BearerTokenConfig": { "id": "BearerTokenConfig", "type": "object", "properties": { "token": { "description": "Required. The bearer token. Must be in the format `$context.variables.`.", "type": "string" } }, "description": "Configurations for authentication with a bearer token." }, "OAuthConfig": { "type": "object", "id": "OAuthConfig", "description": "Configurations for authentication with OAuth.", "properties": { "oauthGrantType": { "type": "string", "enum": [ "OAUTH_GRANT_TYPE_UNSPECIFIED", "CLIENT_CREDENTIAL" ], "description": "Required. OAuth grant types.", "enumDescriptions": [ "Unspecified. Defaults to CLIENT_CREDENTIAL.", "Represents the [client credential flow](https://oauth.net/2/grant-types/client-credentials)." ] }, "clientId": { "type": "string", "description": "Required. The client ID from the OAuth provider." }, "tokenEndpoint": { "type": "string", "description": "Required. The token endpoint in the OAuth provider to exchange for an access token." }, "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" }, "scopes": { "description": "Optional. The OAuth scopes to grant.", "type": "array", "items": { "type": "string" } } } }, "McpToolset": { "id": "McpToolset", "type": "object", "properties": { "customHeaders": { "additionalProperties": { "type": "string" }, "type": "object", "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." }, "tlsConfig": { "$ref": "TlsConfig", "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust." }, "serverAddress": { "type": "string", "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." }, "toolOverrides": { "items": { "$ref": "McpToolOverride" }, "type": "array", "description": "Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic." }, "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" }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.", "$ref": "ServiceDirectoryConfig" } }, "description": "A toolset that contains a list of tools that are offered by the MCP server." }, "EvaluationRun": { "type": "object", "properties": { "evaluationRunSummaries": { "type": "object", "additionalProperties": { "$ref": "EvaluationRunEvaluationRunSummary" }, "description": "Output only. Map of evaluation name to EvaluationRunSummary.", "readOnly": true }, "evaluationResults": { "description": "Output only. The evaluation results that are part of this run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "latencyReport": { "readOnly": true, "description": "Output only. Latency report for the evaluation run.", "$ref": "LatencyReport" }, "changelogCreateTime": { "description": "Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.", "format": "google-datetime", "type": "string", "readOnly": true }, "error": { "description": "Output only. Deprecated: Use error_info instead. Errors encountered during execution.", "readOnly": true, "$ref": "Status", "deprecated": true }, "name": { "description": "Identifier. The unique identifier of the evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`", "type": "string" }, "config": { "readOnly": true, "description": "Output only. The configuration used in the run.", "$ref": "EvaluationConfig" }, "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}`" }, "changelog": { "description": "Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.", "type": "string", "readOnly": 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" }, "state": { "enumDescriptions": [ "Evaluation run state is not specified.", "Indicates the evaluation run is queued.", "Evaluation run is running.", "Evaluation run has completed.", "The evaluation run has an error.", "Evaluation run was cancelled." ], "readOnly": true, "type": "string", "description": "Output only. The state of the evaluation run.", "enum": [ "EVALUATION_RUN_STATE_UNSPECIFIED", "QUEUED", "RUNNING", "COMPLETED", "ERROR", "CANCELLED" ] }, "evaluations": { "description": "Output only. The evaluations that are part of this run. The list may contain evaluations of either type. This field is mutually exclusive with `evaluation_dataset`. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "readOnly": true, "type": "array", "items": { "type": "string" } }, "appVersion": { "type": "string", "description": "Output only. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "readOnly": true }, "progress": { "$ref": "EvaluationRunProgress", "readOnly": true, "description": "Output only. The progress of the evaluation run." }, "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, "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ], "description": "Output only. The method used to run the evaluation.", "type": "string" }, "evaluationDataset": { "description": "Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with `evaluations`. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "readOnly": true, "type": "string" }, "displayName": { "type": "string", "description": "Optional. User-defined display name of the evaluation run. default: \" run - \"." }, "personaRunConfigs": { "readOnly": true, "type": "array", "items": { "$ref": "PersonaRunConfig" }, "description": "Output only. The configuration to use for the run per persona." }, "operation": { "description": "Output only. The operation that created this evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation}`", "type": "string", "readOnly": true }, "initiatedBy": { "description": "Output only. The user who initiated the evaluation run.", "type": "string", "readOnly": true }, "errorInfo": { "readOnly": true, "description": "Output only. Error information for the evaluation run.", "$ref": "EvaluationErrorInfo" }, "runCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The number of times the evaluations inside the run were run." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when the evaluation run was created.", "readOnly": true }, "evaluationType": { "readOnly": true, "enum": [ "EVALUATION_TYPE_UNSPECIFIED", "GOLDEN", "SCENARIO", "MIXED" ], "enumDescriptions": [ "Evaluation type is not specified.", "Golden evaluation.", "Scenario evaluation.", "Indicates the run includes a mix of golden and scenario evaluations." ], "description": "Output only. The type of the evaluations in this run.", "type": "string" }, "appVersionDisplayName": { "type": "string", "description": "Output only. The display name of the `app_version` that the evaluation ran against.", "readOnly": true } }, "description": "An evaluation run represents an all the evaluation results from an evaluation execution.", "id": "EvaluationRun" }, "ToolCall": { "type": "object", "description": "Request for the client or the agent to execute the specified tool.", "properties": { "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "args": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The input parameters and values for the tool in JSON object format." }, "parentToolCallId": { "description": "Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.", "type": "string", "readOnly": true }, "id": { "type": "string", "description": "Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse." }, "toolsetTool": { "$ref": "ToolsetTool", "description": "Optional. The toolset tool to execute." }, "displayName": { "type": "string", "description": "Output only. Display name of the tool.", "readOnly": true }, "agentName": { "description": "Output only. Human-readable name of the agent that issued this call, e.g. \"Contract Architect\". Empty when the root agent issued it.", "readOnly": true, "type": "string" } }, "id": "ToolCall" }, "EvaluationExpectation": { "description": "An evaluation expectation represents a specific criteria to evaluate against.", "properties": { "tags": { "items": { "type": "string" }, "type": "array", "description": "Optional. User-defined tags for expectations. Can be used to filter expectations." }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the evaluation expectation was last updated.", "format": "google-datetime" }, "llmCriteria": { "description": "Optional. Evaluation criteria based on an LLM prompt.", "$ref": "EvaluationExpectationLlmCriteria" }, "name": { "type": "string", "description": "Identifier. The unique identifier of this evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`" }, "etag": { "type": "string", "readOnly": true, "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes." }, "createTime": { "description": "Output only. Timestamp when the evaluation expectation was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "displayName": { "type": "string", "description": "Required. User-defined display name. Must be unique within the app." } }, "id": "EvaluationExpectation", "type": "object" }, "RemoteA2aConfig": { "id": "RemoteA2aConfig", "type": "object", "properties": { "streamingEnabled": { "type": "boolean", "description": "Optional. Whether streaming is enabled for the remote agent." }, "agentRegistry": { "type": "string", "description": "Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`" }, "apiAuthentication": { "description": "Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.", "$ref": "ApiAuthentication" }, "contextId": { "type": "string", "description": "Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`." }, "inputVariableMapping": { "description": "Optional. Mapping of input variable names of remote agent to GECX variable names.", "additionalProperties": { "type": "string" }, "type": "object" }, "outputVariableMapping": { "description": "Optional. Mapping of output variable names of remote agent to GECX variable names.", "type": "object", "additionalProperties": { "type": "string" } }, "agentCard": { "$ref": "AgentCard", "description": "Optional. The full agent card defined inline." } }, "description": "Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent." }, "AssistantOutput": { "description": "The output from the assistant agent.", "type": "object", "id": "AssistantOutput", "properties": { "message": { "description": "Required. The response from the assistant agent.", "$ref": "AssistantMessage" }, "userResponseSuggestions": { "readOnly": true, "description": "Output only. Suggested user responses from the assistant agent.", "$ref": "UserResponseSuggestions" } } }, "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds": { "id": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds", "properties": { "toolInvocationParameterCorrectnessThreshold": { "format": "float", "type": "number", "description": "Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0." } }, "type": "object", "description": "Expectation level metrics thresholds." }, "TestPersonaVoiceResponse": { "type": "object", "description": "Response message for EvaluationService.TestPersonaVoice.", "properties": { "audio": { "type": "string", "format": "byte", "description": "The audio data bytes of the synthesized voice." } }, "id": "TestPersonaVoiceResponse" }, "Image": { "description": "Represents an image input or output in the conversation.", "properties": { "mimeType": { "type": "string", "description": "Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp" }, "altText": { "description": "Optional. The alternative text for the image.", "type": "string" }, "data": { "type": "string", "description": "Required. Raw bytes of the image.", "format": "byte" } }, "id": "Image", "type": "object" }, "RunAssistantResponse": { "properties": { "output": { "$ref": "AssistantOutput", "description": "Required. The output from the assistant agent." }, "state": { "readOnly": true, "enum": [ "ASSISTANT_SESSION_STATE_UNSPECIFIED", "PROCESSING", "IDLE", "PENDING_REVIEW" ], "description": "Output only. The status of the assistant session.", "enumDescriptions": [ "The default value. This value is used if the status is not specified.", "The assistant agent is processing the request as a long running task.", "The assistant agent is idle and does not have any pending requests or response.", "The assistant agent is done processing a long running task and has a response ready for the user." ], "type": "string" } }, "type": "object", "id": "RunAssistantResponse", "description": "Response message for AssistantService.RunAssistant." }, "ListEvaluationDatasetsResponse": { "id": "ListEvaluationDatasetsResponse", "properties": { "evaluationDatasets": { "description": "The list of evaluation datasets.", "type": "array", "items": { "$ref": "EvaluationDataset" } }, "nextPageToken": { "type": "string", "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": "object", "description": "Response message for EvaluationService.ListEvaluationDatasets." }, "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" } }, "id": "TimeZoneSettings", "type": "object" }, "GenerateAppResourceRequestRefineInstructions": { "type": "object", "properties": { "startIndex": { "format": "int64", "type": "string", "description": "Required. The first character (inclusive) of the text to refine." }, "instructions": { "description": "Required. The instructions to refine the resource.", "type": "string" }, "endIndex": { "type": "string", "format": "int64", "description": "Required. The last character (inclusive) of the text to refine." }, "fieldMask": { "type": "string", "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" } }, "description": "The instructions to be used to refine a part of the resource. The part of the resource can be specified with a start index, end index and a field mask. For example, if you want to refine a part of the agent instructions you can specify the index of the first character of the instructions, the index of the last character of the instructions and the field mask as \"instructions\".", "id": "GenerateAppResourceRequestRefineInstructions" }, "SessionInput": { "id": "SessionInput", "description": "Input for the session.", "properties": { "text": { "description": "Optional. Text data from the end user.", "type": "string" }, "blob": { "description": "Optional. Blob data from the end user.", "$ref": "Blob" }, "image": { "$ref": "Image", "description": "Optional. Image data from the end user." }, "audio": { "format": "byte", "description": "Optional. Audio data from the end user.", "type": "string" }, "event": { "$ref": "Event", "description": "Optional. Event input." }, "toolResponses": { "description": "Optional. Execution results for the tool calls from the client.", "$ref": "ToolResponses" }, "willContinue": { "type": "boolean", "description": "Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal." }, "variables": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the 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." }, "dtmf": { "description": "Optional. DTMF digits from the end user.", "type": "string" } }, "type": "object" }, "LfA2aV1DeviceCodeOAuthFlow": { "properties": { "deviceAuthorizationUrl": { "type": "string", "description": "Required. The device authorization endpoint URL." }, "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "tokenUrl": { "description": "Required. The token URL to be used for this flow.", "type": "string" }, "scopes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Required. The available scopes for the OAuth2 security scheme." } }, "type": "object", "id": "LfA2aV1DeviceCodeOAuthFlow", "description": "Defines configuration details for the OAuth 2.0 Device Code flow (RFC 8628). This flow is designed for input-constrained devices such as IoT devices, and CLI tools where the user authenticates on a separate device." }, "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.", "type": "object", "id": "EvaluationMetricsConfigToolCorrectnessMetricsConfig", "properties": { "enableToolCorrectnessMetrics": { "description": "Optional. Whether to calculate tool correctness metrics for the evaluation.", "type": "boolean" } } }, "LfA2aV1TaskPushNotificationConfig": { "type": "object", "description": "A container associating a push notification configuration with a specific task.", "properties": { "tenant": { "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "type": "string" }, "url": { "description": "Required. The URL where the notification should be sent.", "type": "string" }, "taskId": { "description": "The ID of the task this configuration is associated with.", "type": "string" }, "id": { "description": "The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.", "type": "string" }, "token": { "description": "A token unique for this task or session.", "type": "string" }, "authentication": { "description": "Authentication information required to send the notification.", "$ref": "LfA2aV1AuthenticationInfo" } }, "id": "LfA2aV1TaskPushNotificationConfig" }, "LatencyReportCallbackLatency": { "id": "LatencyReportCallbackLatency", "description": "Latency metrics for a single callback.", "type": "object", "properties": { "stage": { "type": "string", "description": "Output only. The stage of the callback.", "readOnly": true }, "latencyMetrics": { "$ref": "LatencyReportLatencyMetrics", "description": "Output only. The latency metrics for the callback.", "readOnly": true } } }, "TriggerAction": { "description": "Action that is taken when a certain precondition is met.", "properties": { "generativeAnswer": { "description": "Optional. Respond with a generative answer.", "$ref": "TriggerActionGenerativeAnswer" }, "transferAgent": { "$ref": "TriggerActionTransferAgent", "description": "Optional. Transfer the conversation to a different agent." }, "respondImmediately": { "$ref": "TriggerActionRespondImmediately", "description": "Optional. Immediately respond with a preconfigured response." } }, "type": "object", "id": "TriggerAction" }, "ListOperationsResponse": { "properties": { "unreachable": { "type": "array", "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "type": "array", "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request." } }, "id": "ListOperationsResponse", "type": "object", "description": "The response message for Operations.ListOperations." }, "EvaluationResultSemanticSimilarityResult": { "id": "EvaluationResultSemanticSimilarityResult", "type": "object", "description": "The result of the semantic similarity check.", "properties": { "explanation": { "type": "string", "description": "Output only. The explanation for the semantic similarity score.", "readOnly": true }, "score": { "description": "Output only. The semantic similarity score. Can be 0, 1, 2, 3, or 4.", "readOnly": true, "type": "integer", "format": "int32" }, "outcome": { "type": "string", "readOnly": true, "description": "Output only. The outcome of the semantic similarity check. This is determined by comparing the score to the semantic_similarity_success_threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.", "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ] }, "label": { "type": "string", "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 } } }, "ChannelProfilePersonaProperty": { "properties": { "persona": { "type": "string", "enum": [ "UNKNOWN", "CONCISE", "CHATTY" ], "description": "Optional. The persona of the channel.", "enumDescriptions": [ "UNKNOWN persona.", "The agent keeps the responses concise and to the point", "The agent provides additional context, explanations, and details" ] } }, "type": "object", "id": "ChannelProfilePersonaProperty", "description": "Represents the persona property of a channel." }, "DataStoreToolBoostSpec": { "id": "DataStoreToolBoostSpec", "properties": { "conditionBoostSpecs": { "type": "array", "items": { "$ref": "DataStoreToolBoostSpecConditionBoostSpec" }, "description": "Required. A list of boosting specifications." } }, "description": "Boost specification to boost certain documents.", "type": "object" }, "ErrorHandlingSettings": { "id": "ErrorHandlingSettings", "type": "object", "properties": { "errorHandlingStrategy": { "enumDescriptions": [ "Unspecified error handling strategy.", "No specific handling is enabled.", "A fallback message will be returned to the user in case of system errors (e.g. LLM errors).", "An EndSession signal will be emitted in case of system errors (e.g. LLM errors)." ], "description": "Optional. The strategy to use for error handling.", "type": "string", "enum": [ "ERROR_HANDLING_STRATEGY_UNSPECIFIED", "NONE", "FALLBACK_RESPONSE", "END_SESSION" ] }, "endSessionConfig": { "description": "Optional. Configuration for ending the session in case of system errors (e.g. LLM errors).", "$ref": "ErrorHandlingSettingsEndSessionConfig" }, "fallbackResponseConfig": { "$ref": "ErrorHandlingSettingsFallbackResponseConfig", "description": "Optional. Configuration for handling fallback responses." } }, "description": "Settings to describe how errors should be handled in the app." }, "DashboardSettings": { "properties": { "defaultDashboard": { "description": "Optional. The resource name of the default Contact Center Insights dashboard associated with the app. This is the dashboard that will be displayed when users navigate to the Monitoring view for the app. Format: `projects/{project}/locations/{location}/dashboards/{dashboard}`", "type": "string" } }, "description": "Settings for dashboards associated with the app, that show up in the Monitoring view.", "id": "DashboardSettings", "type": "object" }, "LanguageSettings": { "description": "Language settings of the app.", "properties": { "supportedLanguageCodes": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of languages codes supported by the app, in addition to the `default_language_code`." }, "enableMultilingualSupport": { "type": "boolean", "description": "Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input." }, "fallbackAction": { "deprecated": true, "type": "string", "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." }, "defaultLanguageCode": { "description": "Optional. The default language code of the app.", "type": "string" } }, "id": "LanguageSettings", "type": "object" }, "GenerateEvaluationRequest": { "type": "object", "properties": { "evaluationType": { "type": "string", "enum": [ "EVALUATION_TYPE_UNSPECIFIED", "GOLDEN", "SCENARIO" ], "enumDescriptions": [ "Unspecified type. Defaults to GOLDEN.", "Golden evaluation.", "Scenario evaluation." ], "description": "Optional. The type of evaluation to generate. Defaults to GOLDEN if unspecified." }, "source": { "description": "Optional. Indicate the source of the conversation. If not set, all sources will be searched.", "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "deprecated": true, "type": "string" } }, "description": "Request message for EvaluationService.GenerateEvaluation.", "id": "GenerateEvaluationRequest" }, "McpTool": { "description": "An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details.", "properties": { "serviceDirectoryConfig": { "$ref": "ServiceDirectoryConfig", "description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter." }, "name": { "description": "Required. The name of the MCP tool.", "type": "string" }, "nameOverride": { "type": "string", "description": "Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override." }, "inputSchema": { "description": "Optional. The schema of the input arguments of the MCP tool.", "$ref": "Schema" }, "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" }, "state": { "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "STALE" ], "readOnly": true, "enumDescriptions": [ "Default state.", "The tool is available and actively offered by the server.", "The tool is configured or pinned, but currently not offered by the server.", "The tool exists on the server, but does not match the version on the server." ], "type": "string", "description": "Output only. The dynamic availability state of the tool on the external server." }, "outputSchema": { "$ref": "Schema", "description": "Optional. The schema of the output arguments of the MCP tool." }, "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" }, "tlsConfig": { "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust.", "$ref": "TlsConfig" }, "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" } }, "type": "object", "id": "McpTool" }, "ListAppsResponse": { "id": "ListAppsResponse", "description": "Response message for AgentService.ListApps.", "type": "object", "properties": { "unreachable": { "description": "Unordered list. Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "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" } } }, "ListAgentsResponse": { "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": { "description": "The list of agents.", "type": "array", "items": { "$ref": "Agent" } } }, "type": "object", "description": "Response message for AgentService.ListAgents.", "id": "ListAgentsResponse" }, "AgentCard": { "id": "AgentCard", "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", "type": "object", "properties": { "name": { "description": "Required. A human-readable name for the agent.", "type": "string" }, "skills": { "items": { "$ref": "AgentSkill" }, "description": "Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.", "type": "array" }, "supportedInterfaces": { "description": "Required. Ordered list of supported interfaces. The first entry is preferred.", "items": { "$ref": "AgentInterface" }, "type": "array" }, "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" } } }, "InstagramCredentials": { "id": "InstagramCredentials", "properties": { "authCode": { "description": "Required. The Meta auth code provided by the embedded signup flow.", "type": "string" }, "conversationProfileId": { "description": "Optional. The Conversation Profile ID to use for the deployment.", "type": "string" } }, "description": "Ephemeral Meta credentials for Instagram native integration.", "type": "object" }, "GenerateAppResourceRequestToolGenerationConfig": { "id": "GenerateAppResourceRequestToolGenerationConfig", "type": "object", "properties": { "context": { "description": "Optional. The context which describes the tool to be generated. This can be empty if the tool request & response are provided.", "type": "string" }, "fileContexts": { "type": "array", "items": { "$ref": "FileContext" }, "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" } }, "description": "The configuration to be used to generate a tool." }, "GenerateEvaluationOperationMetadata": { "type": "object", "id": "GenerateEvaluationOperationMetadata", "properties": {}, "description": "Operation metadata for EvaluationService.GenerateEvaluation." }, "ActionEntityOperation": { "id": "ActionEntityOperation", "type": "object", "properties": { "entityId": { "type": "string", "description": "Required. ID of the entity." }, "operation": { "description": "Required. Operation to perform on the entity.", "enumDescriptions": [ "Operation type unspecified. Invalid, ConnectorTool create/update will fail.", "List operation.", "Get operation.", "Create operation.", "Update operation.", "Delete operation." ], "type": "string", "enum": [ "OPERATION_TYPE_UNSPECIFIED", "LIST", "GET", "CREATE", "UPDATE", "DELETE" ] } }, "description": "Entity CRUD operation specification." }, "ListEvaluationExpectationsResponse": { "id": "ListEvaluationExpectationsResponse", "description": "Response message for EvaluationService.ListEvaluationExpectations.", "type": "object", "properties": { "evaluationExpectations": { "type": "array", "description": "The list of evaluation expectations.", "items": { "$ref": "EvaluationExpectation" } }, "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" } } }, "ExportOptions": { "description": "Options for exporting CES evaluation resources.", "type": "object", "properties": { "exportFormat": { "type": "string", "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "description": "Optional. The format to export the evaluation results in. Defaults to JSON if not specified.", "enumDescriptions": [ "Unspecified format.", "JSON format.", "YAML format." ] }, "gcsUri": { "description": "Optional. The Google Cloud Storage URI to write the exported Evaluation Results to.", "type": "string" } }, "id": "ExportOptions" }, "AggregatedMetricsMetricsByAppVersion": { "type": "object", "properties": { "passCount": { "format": "int32", "description": "Output only. The number of times the evaluation passed.", "readOnly": true, "type": "integer" }, "turnLatencyMetrics": { "readOnly": true, "description": "Output only. Metrics for turn latency within this app version.", "type": "array", "items": { "$ref": "AggregatedMetricsTurnLatencyMetrics" } }, "appVersionId": { "type": "string", "description": "Output only. The app version ID.", "readOnly": true }, "semanticSimilarityMetrics": { "items": { "$ref": "AggregatedMetricsSemanticSimilarityMetrics" }, "type": "array", "readOnly": true, "description": "Output only. Metrics for semantic similarity within this app version." }, "metricsByTurn": { "items": { "$ref": "AggregatedMetricsMetricsByTurn" }, "readOnly": true, "type": "array", "description": "Output only. Metrics aggregated per turn within this app version." }, "toolMetrics": { "description": "Output only. Metrics for each tool within this app version.", "items": { "$ref": "AggregatedMetricsToolMetrics" }, "type": "array", "readOnly": true }, "hallucinationMetrics": { "items": { "$ref": "AggregatedMetricsHallucinationMetrics" }, "type": "array", "readOnly": true, "description": "Output only. Metrics for hallucination within this app version." }, "failCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The number of times the evaluation failed." }, "toolCallLatencyMetrics": { "readOnly": true, "type": "array", "items": { "$ref": "AggregatedMetricsToolCallLatencyMetrics" }, "description": "Output only. Metrics for tool call latency within this app version." } }, "description": "Metrics aggregated per app version.", "id": "AggregatedMetricsMetricsByAppVersion" }, "OpenApiToolset": { "type": "object", "id": "OpenApiToolset", "description": "A toolset that contains a list of tools that are defined by an OpenAPI schema.", "properties": { "tlsConfig": { "$ref": "TlsConfig", "description": "Optional. The TLS configuration. Includes the custom server certificates" }, "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" }, "apiAuthentication": { "$ref": "ApiAuthentication", "description": "Optional. Authentication information required by the API." }, "openApiSchema": { "type": "string", "description": "Required. The OpenAPI schema of the toolset." }, "url": { "type": "string", "description": "Optional. The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema." }, "serviceDirectoryConfig": { "description": "Optional. Service Directory configuration.", "$ref": "ServiceDirectoryConfig" } } }, "LfA2aV1SecurityScheme": { "properties": { "openIdConnectSecurityScheme": { "$ref": "LfA2aV1OpenIdConnectSecurityScheme", "description": "OpenID Connect authentication." }, "httpAuthSecurityScheme": { "description": "HTTP authentication (Basic, Bearer, etc.).", "$ref": "LfA2aV1HTTPAuthSecurityScheme" }, "apiKeySecurityScheme": { "description": "API key-based authentication.", "$ref": "LfA2aV1APIKeySecurityScheme" }, "mtlsSecurityScheme": { "description": "Mutual TLS authentication.", "$ref": "LfA2aV1MutualTlsSecurityScheme" }, "oauth2SecurityScheme": { "$ref": "LfA2aV1OAuth2SecurityScheme", "description": "OAuth 2.0 authentication." } }, "type": "object", "id": "LfA2aV1SecurityScheme", "description": "Defines a security scheme that can be used to secure an agent's endpoints. This is a discriminated union type based on the OpenAPI 3.2 Security Scheme Object. See: https://spec.openapis.org/oas/v3.2.0.html#security-scheme-object" }, "EvaluationGolden": { "description": "The steps required to replay a golden conversation.", "id": "EvaluationGolden", "type": "object", "properties": { "evaluationExpectations": { "type": "array", "description": "Optional. The evaluation expectations to evaluate the replayed conversation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}`", "items": { "type": "string" } }, "turns": { "description": "Required. The golden turns required to replay a golden conversation. The maximum number of allowed turns is 100.", "type": "array", "items": { "$ref": "EvaluationGoldenTurn" } } } }, "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": { "payload": { "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": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "endUserMetadata": { "description": "Optional. The end user metadata to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "webhookHeaders": { "additionalProperties": { "type": "string" }, "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)." } }, "type": "object", "id": "SessionConfigRemoteDialogflowQueryParameters" }, "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", "type": "object", "properties": { "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" }, "toolset": { "$ref": "ToolsetTool", "description": "Optional. The toolset to mock." }, "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." } }, "toolId": { "description": "Optional. The name of the tool to mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "tool": { "description": "Optional. Deprecated. Use tool_identifier instead.", "deprecated": true, "type": "string" } } }, "FileContext": { "description": "Files to be used as context. Files can be provided as raw bytes.", "id": "FileContext", "properties": { "fileBytes": { "$ref": "FileContextFileBytes", "description": "Optional. File provided as raw bytes." } }, "type": "object" }, "WidgetToolTextResponseConfig": { "description": "Configuration for the text response returned with the widget.", "id": "WidgetToolTextResponseConfig", "type": "object", "properties": { "type": { "description": "Optional. The strategy for providing the text response.", "type": "string", "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." ] }, "staticText": { "description": "Optional. The static text response to return when type is STATIC.", "type": "string" }, "textResponseInstruction": { "type": "string", "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." } } }, "EvaluationResultScenarioExpectationOutcome": { "description": "The outcome of a scenario expectation.", "type": "object", "properties": { "outcome": { "readOnly": true, "description": "Output only. The outcome of the ScenarioExpectation.", "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ], "type": "string" }, "expectation": { "readOnly": true, "description": "Output only. The expectation that was evaluated.", "$ref": "EvaluationScenarioExpectation" }, "observedToolCall": { "description": "Output only. The observed tool call.", "readOnly": true, "$ref": "EvaluationResultScenarioExpectationOutcomeObservedToolCall" }, "observedAgentResponse": { "readOnly": true, "description": "Output only. The observed agent response.", "$ref": "Message" } }, "id": "EvaluationResultScenarioExpectationOutcome" }, "EvaluationResultHallucinationResult": { "id": "EvaluationResultHallucinationResult", "description": "The result of the hallucination check for a single turn.", "type": "object", "properties": { "score": { "format": "int32", "readOnly": true, "type": "integer", "description": "Output only. The hallucination score. Can be -1, 0, 1." }, "explanation": { "readOnly": true, "type": "string", "description": "Output only. The explanation for the hallucination score." }, "label": { "description": "Output only. The label associated with each score. Score 1: Justified Score 0: Not Justified Score -1: No Claim To Assess", "type": "string", "readOnly": true } } }, "EvaluationGoldenExpectation": { "description": "Represents a single, checkable requirement.", "id": "EvaluationGoldenExpectation", "type": "object", "properties": { "updatedVariables": { "description": "Optional. Check that the agent updated the session variables to the expected values. Used to also capture agent variable updates for golden evals.", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "mockToolResponse": { "$ref": "ToolResponse", "description": "Optional. The tool response to mock, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM." }, "agentResponseSemanticSimilarityMetricsConfigOverride": { "$ref": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig", "description": "Optional. Overrides for agent_response semantic similarity metrics." }, "expectationLevelMetricsThresholdsOverride": { "description": "Optional. Overrides metrics at the step level.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds" }, "note": { "type": "string", "description": "Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., \"Check_Payment_Tool_Called\"." }, "toolResponse": { "description": "Optional. Check that a specific tool had the expected response.", "$ref": "ToolResponse" }, "agentTransfer": { "$ref": "AgentTransfer", "description": "Optional. Check that the agent transferred the conversation to a different agent." }, "agentResponseHallucinationMetricsConfigOverride": { "description": "Optional. Overrides for agent_response hallucination metrics.", "$ref": "EvaluationMetricsConfigHallucinationMetricsConfig" }, "toolCall": { "$ref": "ToolCall", "description": "Optional. Check that a specific tool was called with the parameters." }, "noToolCalls": { "description": "Optional. Check that no tools were called during this turn.", "type": "boolean" }, "agentResponse": { "description": "Optional. Check that the agent responded with the correct response. The role \"agent\" is implied.", "$ref": "Message" }, "skipEvaluation": { "description": "Optional. If set to true, this specific expectation will not be evaluated.", "type": "boolean" }, "comparisonType": { "enumDescriptions": [ "Unspecified comparison type. Behavior defaults to SEMANTIC_SIMILARITY for agent responses and tool calls.", "Exact string match.", "Substring match (checks if the expected string is contained in the actual response).", "Semantic similarity match (evaluates meaning similarity using an LLM)." ], "type": "string", "enum": [ "COMPARISON_TYPE_UNSPECIFIED", "EQUALS", "CONTAINS", "SEMANTIC_SIMILARITY" ], "description": "Optional. The comparison type to use for the expectation check." } } }, "OptimizationConfig": { "properties": { "errorMessage": { "type": "string", "description": "Output only. The error message if the optimization run failed.", "readOnly": true }, "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." }, "assistantSession": { "description": "Output only. The assistant session to use for the optimization based on this evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}`", "readOnly": true, "type": "string" }, "reportSummary": { "readOnly": true, "description": "Output only. The summary of the loss report.", "type": "string" }, "lossReport": { "description": "Output only. The generated loss report.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "readOnly": true }, "status": { "enum": [ "OPTIMIZATION_STATUS_UNSPECIFIED", "RUNNING", "COMPLETED", "ERROR" ], "description": "Output only. The status of the optimization run.", "readOnly": true, "type": "string", "enumDescriptions": [ "Optimization status is not specified.", "Optimization is running.", "Optimization has completed.", "Optimization failed due to an internal error." ] } }, "type": "object", "id": "OptimizationConfig", "description": "Configuration for running the optimization step after the evaluation run." }, "AssistantConfirmationResponse": { "properties": { "answerText": { "description": "The chosen option's submit_text, or free-form user text. The paused action is cancelled and the text is handed to the agent to act on.", "type": "string" }, "confirmationId": { "description": "The AssistantConfirmationRequest.confirmation_id being answered.", "type": "string" }, "confirmed": { "type": "boolean", "description": "Binary answer: true approves the paused action, false declines it." } }, "type": "object", "description": "The user's answer to an AssistantConfirmationRequest, sent on the next SessionService.StreamChatAiAssistant call to resume the paused agent.", "id": "AssistantConfirmationResponse" }, "LfA2aV1StreamResponse": { "id": "LfA2aV1StreamResponse", "properties": { "message": { "$ref": "LfA2aV1Message", "description": "A Message object containing a message from the agent." }, "artifactUpdate": { "description": "An event indicating a task artifact update.", "$ref": "LfA2aV1TaskArtifactUpdateEvent" }, "statusUpdate": { "description": "An event indicating a task status update.", "$ref": "LfA2aV1TaskStatusUpdateEvent" }, "task": { "$ref": "LfA2aV1Task", "description": "A Task object containing the current state of the task." } }, "description": "A wrapper object used in streaming operations to encapsulate different types of response data.", "type": "object" }, "AppSnapshot": { "type": "object", "description": "A snapshot of the app.", "properties": { "agents": { "items": { "$ref": "Agent" }, "description": "Optional. List of agents in the app.", "type": "array" }, "examples": { "type": "array", "items": { "$ref": "Example" }, "description": "Optional. List of examples in the app." }, "toolsets": { "items": { "$ref": "Toolset" }, "description": "Optional. List of toolsets in the app.", "type": "array" }, "guardrails": { "description": "Optional. List of guardrails in the app.", "type": "array", "items": { "$ref": "Guardrail" } }, "app": { "$ref": "App", "description": "Optional. The basic settings for the app." }, "tools": { "items": { "$ref": "Tool" }, "description": "Optional. List of tools in the app.", "type": "array" } }, "id": "AppSnapshot" }, "LfA2aV1OAuth2SecurityScheme": { "type": "object", "description": "Defines a security scheme using OAuth 2.0.", "id": "LfA2aV1OAuth2SecurityScheme", "properties": { "oauth2MetadataUrl": { "description": "URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.", "type": "string" }, "flows": { "description": "Required. An object containing configuration information for the supported OAuth 2.0 flows.", "$ref": "LfA2aV1OAuthFlows" }, "description": { "description": "An optional description for the security scheme.", "type": "string" } } }, "ModelSettings": { "type": "object", "description": "Model settings contains various configurations for the LLM model.", "id": "ModelSettings", "properties": { "thinkingLevel": { "enumDescriptions": [ "Thinking level is unspecified.", "Default thinking level.", "Low thinking level.", "Medium thinking level.", "High thinking level." ], "type": "string", "enum": [ "THINKING_LEVEL_UNSPECIFIED", "DEFAULT", "LOW", "MEDIUM", "HIGH" ], "description": "Optional. The thinking level of the model." }, "temperature": { "format": "double", "description": "Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.", "type": "number" }, "model": { "type": "string", "description": "Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent." } } }, "GenerateChatTokenResponse": { "properties": { "chatToken": { "description": "The session scoped token for chat widget to authenticate with Session APIs.", "type": "string" }, "expireTime": { "description": "The time at which the chat token expires.", "format": "google-datetime", "type": "string" } }, "id": "GenerateChatTokenResponse", "type": "object", "description": "Response message for WidgetService.GenerateChatToken." }, "TurnMetadata": { "description": "Turn-level metadata and intent categorization.", "properties": { "contractStreamingPhase": { "description": "Set only on in-flight progress estimates emitted while a contract artifact fence is streaming, and on the revision-turn-start event. Unset on authoritative payloads.", "type": "string", "enum": [ "CONTRACT_STREAMING_PHASE_UNSPECIFIED", "DRAFTING", "REVISING" ], "enumDescriptions": [ "The payload is authoritative (computed from a complete contract document, a persisted snapshot, or the pre-draft state). Clients must replace any previously received progress with it.", "An initial contract draft is streaming. contract_progress is an in-flight estimate: non-decreasing within one artifact fence, capped below the authoritative range, with pillar_breakdowns carrying total_item_count == 0 to mark estimated pillar states.", "A revision of an existing contract is streaming (for example after an annotation submission). Same estimate semantics as DRAFTING." ] }, "contractFinalized": { "type": "boolean", "description": "Set on the final artifact event of a turn whose contract draft was published (a revision was activated). Terminal for the clarification flow of this draft: contract_progress is authoritative and complete." }, "contractDraftComplete": { "description": "Set on the terminal event of a contract draft whose every placeholder is resolved (contract_progress is 100%), whether or not the draft was published. Clients complete and dismiss the contract progress display on it; publication is reported separately by contract_finalized.", "type": "boolean" }, "contractRelated": { "description": "Indicates whether this assistant turn was contract-related (e.g. contract drafting, alignment, extraction, or revision).", "type": "boolean" } }, "type": "object", "id": "TurnMetadata" }, "GuardrailContentFilter": { "type": "object", "properties": { "disregardDiacritics": { "type": "boolean", "description": "Optional. If true, diacritics are ignored during matching." }, "bannedContentsInUserInput": { "items": { "type": "string" }, "type": "array", "description": "Optional. List of banned phrases. Applies only to user inputs." }, "matchType": { "enumDescriptions": [ "Match type is not specified.", "Content is matched for substrings character by character.", "Content only matches if the pattern found in the text is surrounded by word delimiters. Banned phrases can also contain word delimiters.", "Content is matched using regular expression syntax." ], "type": "string", "enum": [ "MATCH_TYPE_UNSPECIFIED", "SIMPLE_STRING_MATCH", "WORD_BOUNDARY_STRING_MATCH", "REGEXP_MATCH" ], "description": "Required. Match type for the content filter." }, "bannedContentsInAgentResponse": { "description": "Optional. List of banned phrases. Applies only to agent responses.", "type": "array", "items": { "type": "string" } }, "bannedContents": { "items": { "type": "string" }, "description": "Optional. List of banned phrases. Applies to both user inputs and agent responses.", "type": "array" } }, "description": "Guardrail that bans certain content from being used in the conversation.", "id": "GuardrailContentFilter" }, "EvaluationResultToolCallLatency": { "id": "EvaluationResultToolCallLatency", "properties": { "startTime": { "readOnly": true, "type": "string", "description": "Output only. The start time of the tool call execution.", "format": "google-datetime" }, "executionLatency": { "type": "string", "description": "Output only. The latency of the tool call execution.", "readOnly": true, "format": "google-duration" }, "endTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The end time of the tool call execution." }, "displayName": { "description": "Output only. The display name of the tool.", "readOnly": true, "type": "string" }, "tool": { "description": "Output only. The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.", "type": "string", "readOnly": true } }, "type": "object", "description": "The latency of a tool call execution." }, "LfA2aV1AgentCapabilities": { "properties": { "extendedAgentCard": { "description": "Indicates if the agent supports providing an extended agent card when authenticated.", "type": "boolean" }, "extensions": { "description": "A list of protocol extensions supported by the agent.", "type": "array", "items": { "$ref": "LfA2aV1AgentExtension" } }, "pushNotifications": { "description": "Indicates if the agent supports sending push notifications for asynchronous task updates.", "type": "boolean" }, "streaming": { "description": "Indicates if the agent supports streaming responses.", "type": "boolean" } }, "description": "Defines optional capabilities supported by an agent.", "id": "LfA2aV1AgentCapabilities", "type": "object" }, "DataStoreToolEngineSource": { "properties": { "engine": { "type": "string", "description": "Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`" }, "dataStoreSources": { "description": "Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.", "items": { "$ref": "DataStoreToolDataStoreSource" }, "type": "array" }, "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" } }, "description": "Configuration for searching within an Engine, potentially targeting specific DataStores.", "id": "DataStoreToolEngineSource", "type": "object" }, "EvaluationResultEvaluationExpectationResult": { "id": "EvaluationResultEvaluationExpectationResult", "type": "object", "description": "The result of a single evaluation expectation.", "properties": { "explanation": { "type": "string", "readOnly": true, "description": "Output only. The explanation for the result." }, "prompt": { "type": "string", "description": "Output only. The prompt that was used for the evaluation.", "readOnly": true }, "outcome": { "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ], "description": "Output only. The outcome of the evaluation expectation.", "readOnly": true, "type": "string" }, "evaluationExpectation": { "readOnly": true, "description": "Output only. The evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`", "type": "string" } } }, "RunSessionResponse": { "type": "object", "properties": { "outputs": { "description": "Outputs for the session.", "type": "array", "items": { "$ref": "SessionOutput" } } }, "description": "Response message for SessionService.RunSession.", "id": "RunSessionResponse" }, "ListEvaluationsResponse": { "type": "object", "description": "Response message for EvaluationService.ListEvaluations.", "id": "ListEvaluationsResponse", "properties": { "evaluations": { "description": "The list of evaluations.", "items": { "$ref": "Evaluation" }, "type": "array" }, "nextPageToken": { "description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } } }, "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.", "type": "object", "id": "MetricAnalysisSettings" }, "LfA2aV1ImplicitOAuthFlow": { "description": "Deprecated: Use Authorization Code + PKCE instead.", "properties": { "scopes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty." }, "authorizationUrl": { "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS", "type": "string" }, "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" } }, "id": "LfA2aV1ImplicitOAuthFlow", "type": "object" }, "AssistantSuggestion": { "description": "A single personalized onboarding suggestion chip for the AI assistant's zero state.", "properties": { "label": { "description": "Chip label shown to the user (at most 60 characters).", "type": "string" }, "rationale": { "type": "string", "description": "Optional short explanation of why this suggestion is shown (tooltip / rationale popover)." }, "sendMessage": { "description": "Prefill the composer with this text and submit immediately. Only used for quick-reply chips inside an active onboarding conversation.", "type": "string" }, "suggestionId": { "description": "Stable identifier for this suggestion, round-tripped by clients in interaction logging.", "type": "string" }, "icon": { "enumDescriptions": [ "Unspecified icon.", "Resume a previous session.", "Build something new.", "Evaluation-related suggestion.", "Deployment-related suggestion.", "Exploration / discovery suggestion.", "Fix an error or failing state." ], "description": "Icon hint for the chip.", "type": "string", "enum": [ "ICON_UNSPECIFIED", "RESUME", "BUILD", "EVALUATE", "DEPLOY", "EXPLORE", "FIX" ] }, "loadSession": { "description": "Open an existing assistant session.", "$ref": "AssistantSuggestionLoadSession" }, "source": { "description": "How this suggestion was produced.", "type": "string", "enum": [ "SOURCE_UNSPECIFIED", "RULE", "LLM_RANKED" ], "enumDescriptions": [ "Unspecified source.", "Deterministic rule-table candidate with template phrasing.", "Rule-table candidate re-ranked and phrased by the LLM phrasing step." ] }, "candidateType": { "description": "Rule-table candidate type in kebab-case (e.g. \"resume-pending-review\"), for metrics.", "type": "string" }, "seedPrompt": { "description": "Prefill the composer with this text; the user reviews and sends.", "type": "string" } }, "type": "object", "id": "AssistantSuggestion" }, "ConversationTurn": { "id": "ConversationTurn", "description": "All information about a single turn in the conversation.", "properties": { "userIntendedText": { "type": "string", "description": "Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled." }, "messages": { "items": { "$ref": "Message" }, "description": "Optional. List of messages in the conversation turn, including user input, agent responses and intermediate events during the processing.", "type": "array" }, "rootSpan": { "description": "Optional. The root span of the action processing.", "$ref": "Span" } }, "type": "object" }, "OptionQuestionsChunkOption": { "description": "A single selectable option.", "id": "OptionQuestionsChunkOption", "type": "object", "properties": { "title": { "type": "string", "description": "Short plain-text option title (no markdown, no numbering)." }, "details": { "type": "string", "description": "Optional trade-off details shown as secondary text." }, "submitText": { "description": "Optional message text to send when the option is chosen; defaults to `title` when empty.", "type": "string" } } }, "ExportEvaluationsRequest": { "id": "ExportEvaluationsRequest", "properties": { "names": { "description": "Required. The resource names of the evaluations to export.", "items": { "type": "string" }, "type": "array" }, "includeEvaluationResults": { "type": "boolean", "description": "Optional. Includes evaluation results in the export. At least one of include_evaluation_results or include_evaluations must be set." }, "exportOptions": { "$ref": "ExportOptions", "description": "Optional. The export options for the evaluations." }, "includeEvaluations": { "description": "Optional. Includes evaluations in the export. At least one of include_evaluation_results or include_evaluations must be set.", "type": "boolean" } }, "type": "object", "description": "Request message for EvaluationService.ExportEvaluations." }, "TestPersonaVoiceRequest": { "properties": { "personaId": { "type": "string", "description": "Required. The persona ID to test the voice for. Also accepts \"default\"." }, "text": { "description": "Required. The text to test the voice for.", "type": "string" } }, "id": "TestPersonaVoiceRequest", "description": "Request message for EvaluationService.TestPersonaVoice.", "type": "object" }, "Span": { "id": "Span", "type": "object", "description": "A span is a unit of work or a single operation during the request processing.", "properties": { "duration": { "readOnly": true, "format": "google-duration", "description": "Output only. The duration of the span.", "type": "string" }, "name": { "readOnly": true, "type": "string", "description": "Output only. The name of the span." }, "startTime": { "description": "Output only. The start time of the span.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "format": "google-datetime", "description": "Output only. The end time of the span.", "readOnly": true, "type": "string" }, "attributes": { "readOnly": true, "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Output only. Key-value attributes associated with the span." }, "childSpans": { "items": { "$ref": "Span" }, "readOnly": true, "description": "Output only. The child spans that are nested under this span.", "type": "array" } } }, "ListToolsetsResponse": { "type": "object", "id": "ListToolsetsResponse", "description": "Response message for AgentService.ListToolsets.", "properties": { "toolsets": { "items": { "$ref": "Toolset" }, "description": "The list of toolsets.", "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" } } }, "McpToolOverride": { "type": "object", "properties": { "nameOverride": { "description": "Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools.", "type": "string" }, "tool": { "description": "Required. The original name of the tool as it is emitted by the MCP server.", "type": "string" }, "snapshot": { "description": "Output only. If present, this tool is \"Pinned\" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present.", "readOnly": true, "$ref": "McpToolDefinition" }, "descriptionOverride": { "type": "string", "description": "Optional. If present, this tool uses this description instead of the original description from the server." } }, "id": "McpToolOverride", "description": "Overrides associated with a given tool in a Toolset. This enables \"pinning\" or \"overriding\" of tool definitions from the external dynamic server." }, "CustomVoiceSample": { "description": "Configuration for a custom voice sample used for voice cloning.", "type": "object", "properties": { "voiceInstruction": { "type": "string", "description": "Optional. Natural language instructions for voice style, tone, pacing, or pronunciation." }, "voiceSampleGcsUri": { "description": "Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.", "type": "string" }, "previewText": { "description": "Optional. Text for synthesizing preview audio for custom voice.", "type": "string" }, "voiceInstructionMode": { "description": "Optional. Instruction mode for the voice sample. If unspecified, defaults to NO_INSTRUCTION.", "type": "string", "enum": [ "VOICE_INSTRUCTION_MODE_UNSPECIFIED", "NO_INSTRUCTION", "GENERATE_INSTRUCTION", "CUSTOM_INSTRUCTION" ], "enumDescriptions": [ "Unspecified instruction mode. Defaults to NO_INSTRUCTION.", "No voice instruction will be used.", "Voice instruction will be automatically generated by AI from the audio sample.", "Custom voice instruction provided by the user." ] }, "previewAudioContent": { "description": "Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).", "type": "string", "readOnly": true, "format": "byte" }, "name": { "description": "Optional. The user-defined name for the custom voice sample.", "type": "string" }, "consentAudioGcsUri": { "description": "Optional. Consent audio for voice cloning.", "type": "string" }, "warnings": { "items": { "$ref": "CustomVoiceSampleWarning" }, "readOnly": true, "description": "Output only. Warning messages encountered during voice clone processing (e.g. low audio level).", "type": "array" } }, "id": "CustomVoiceSample" }, "ImportAppRequest": { "type": "object", "properties": { "importOptions": { "description": "Optional. Options governing the import process for the app.", "$ref": "ImportAppRequestImportOptions" }, "appContent": { "format": "byte", "description": "Raw bytes representing the compressed zip file with the app folder structure.", "type": "string" }, "appId": { "description": "Optional. The ID to use for the imported app. * If not specified, a unique ID will be automatically assigned for the app. * Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced.", "type": "string" }, "displayName": { "description": "Optional. The display name of the app to import. * If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique. * If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error.", "type": "string" }, "ignoreAppLock": { "type": "boolean", "description": "Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock." }, "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" }, "jsonPatchContent": { "description": "Optional. Patch content as a JSON string.", "type": "string" }, "jsonPatchGcsUri": { "description": "Optional. A Cloud Storage URI pointing to a JSON file containing the patches.", "type": "string" } }, "description": "Request message for AgentService.ImportApp.", "id": "ImportAppRequest" }, "SystemTool": { "description": "Pre-defined system tool.", "type": "object", "id": "SystemTool", "properties": { "name": { "description": "Required. The name of the system tool.", "type": "string" }, "description": { "readOnly": true, "description": "Output only. The description of the system tool.", "type": "string" } } }, "EvaluationSettings": { "description": "Settings for evaluation.", "id": "EvaluationSettings", "type": "object", "properties": { "metricsConfig": { "description": "Optional. Configures the default metrics for evaluations.", "$ref": "EvaluationMetricsConfig" }, "evaluationRunCachingSettings": { "description": "Optional. The caching settings to use for the evaluation run.", "$ref": "EvaluationRunCachingSettings" }, "scenarioExecutionMode": { "enumDescriptions": [ "Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.", "Quality optimized mode.", "Speed optimized mode." ], "type": "string", "enum": [ "SCENARIO_EXECUTION_MODE_UNSPECIFIED", "QUALITY_OPTIMIZED", "SPEED_OPTIMIZED" ], "description": "Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED." }, "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.", "type": "string", "enum": [ "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED", "REAL", "FAKE" ] }, "goldenEvaluationToolCallBehaviour": { "type": "string", "enum": [ "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED", "REAL", "FAKE" ], "enumDescriptions": [ "Unspecified tool call behavior. Will default to real tool calls.", "Use real tool calls.", "Use fake tool calls." ], "description": "Optional. Configures the default tool call behaviour for golden evaluations." }, "scenarioConversationInitiator": { "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.", "type": "string", "enum": [ "SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED", "USER", "AGENT" ] }, "goldenRunMethod": { "type": "string", "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." ], "description": "Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest." } } }, "OperationMetadata": { "type": "object", "description": "Represents the metadata of the long-running operation.", "properties": { "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "requestedCancellation": { "type": "boolean", "readOnly": true, "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`." } }, "id": "OperationMetadata" }, "CancelOperationRequest": { "properties": {}, "id": "CancelOperationRequest", "type": "object", "description": "The request message for Operations.CancelOperation." }, "EvaluationGoldenTurn": { "id": "EvaluationGoldenTurn", "properties": { "steps": { "description": "Required. The steps required to replay a golden conversation.", "items": { "$ref": "EvaluationStep" }, "type": "array" }, "turnLevelMetricsThresholdsOverride": { "description": "Optional. Overrides for turn-level metric thresholds.", "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds" }, "hallucinationMetricBehaviorOverride": { "description": "Optional. Override for turn-level hallucination metric behavior.", "type": "string", "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ] }, "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" } }, "description": "A golden turn defines a single turn in a golden conversation.", "type": "object" }, "CloudLoggingSettings": { "id": "CloudLoggingSettings", "type": "object", "description": "Settings to describe the Cloud Logging behaviors for the app.", "properties": { "enableCloudLogging": { "description": "Optional. Whether to enable Cloud Logging for the sessions.", "type": "boolean" } } }, "LfA2aV1SecurityRequirement": { "properties": { "schemes": { "type": "object", "additionalProperties": { "$ref": "LfA2aV1StringList" }, "description": "A map of security schemes to the required scopes." } }, "id": "LfA2aV1SecurityRequirement", "description": "Defines the security requirements for an agent.", "type": "object" }, "CustomVoiceSampleWarning": { "properties": { "message": { "description": "Output only. A human-readable description of the warning.", "type": "string", "readOnly": true }, "type": { "enum": [ "WARNING_TYPE_UNSPECIFIED", "LOW_AUDIO_LEVEL" ], "enumDescriptions": [ "Unspecified warning type.", "The audio level of the voice sample is too low (e.g. low RMS amplitude)." ], "description": "Output only. The type of the warning.", "type": "string", "readOnly": true } }, "type": "object", "id": "CustomVoiceSampleWarning", "description": "A warning message encountered during voice sample processing." }, "ListGuardrailsResponse": { "id": "ListGuardrailsResponse", "description": "Response message for AgentService.ListGuardrails.", "type": "object", "properties": { "guardrails": { "items": { "$ref": "Guardrail" }, "description": "The list of guardrails.", "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" } } }, "AssistantMessage": { "id": "AssistantMessage", "description": "A message in an assistant session.", "properties": { "eventTime": { "format": "google-datetime", "description": "Required. Timestamp when the message was sent or received.", "type": "string" }, "role": { "type": "string", "description": "Required. Role within the conversation \"user\" or \"model\"." }, "attachedGcsUris": { "type": "array", "description": "Optional. Cloud Storage URIs for files uploaded by the user during this turn. This allows attachments to be persisted and rendered in the session history UI. Example: \"gs://cxas-transient-uploads/uuid/prd.pdf\"", "items": { "type": "string" } }, "chunks": { "description": "Optional. Content of the message as chunks.", "items": { "$ref": "AssistantChunk" }, "type": "array" } }, "type": "object" }, "ListDeploymentsResponse": { "type": "object", "id": "ListDeploymentsResponse", "properties": { "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" }, "deployments": { "items": { "$ref": "Deployment" }, "type": "array", "description": "The list of deployments." } }, "description": "Response message for AgentService.ListDeployments." }, "WebSearchQuery": { "id": "WebSearchQuery", "properties": { "query": { "type": "string", "description": "The search query text." }, "uri": { "description": "The URI to the Google Search results page for the query.", "type": "string" } }, "type": "object", "description": "Represents a single web search query and its associated search uri." }, "RedactionConfig": { "properties": { "enableRedaction": { "type": "boolean", "description": "Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording." }, "inspectTemplate": { "type": "string", "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}`" }, "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" } }, "description": "Configuration to instruct how sensitive data should be handled.", "type": "object", "id": "RedactionConfig" }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", "type": "object", "properties": { "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object" } } }, "FileSearchTool": { "type": "object", "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.", "properties": { "fileCorpus": { "type": "string", "description": "Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}" }, "name": { "description": "Required. The tool name.", "type": "string" }, "corpusType": { "type": "string", "enum": [ "CORPUS_TYPE_UNSPECIFIED", "USER_OWNED", "FULLY_MANAGED" ], "description": "Optional. The type of the corpus. Default is FULLY_MANAGED.", "enumDescriptions": [ "Unspecified corpus type.", "The corpus is created and owned by the user.", "The corpus is created by the agent." ] }, "description": { "description": "Optional. The tool description.", "type": "string" } }, "id": "FileSearchTool" }, "AgentTool": { "properties": { "description": { "type": "string", "description": "Optional. Description of the tool's purpose." }, "name": { "description": "Required. The name of the agent tool.", "type": "string" }, "agent": { "type": "string", "description": "Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`" } }, "description": "Represents a tool that allows the agent to call another agent.", "type": "object", "id": "AgentTool" }, "ChatAiAssistantRequest": { "id": "ChatAiAssistantRequest", "properties": { "contextToken": { "type": "string", "description": "Optional. Opaque onboarding context token returned by SessionService.GenerateOnboardingSuggestions. When set and still fresh, the server reuses the onboarding snapshot computed for the zero state instead of recomputing it for the first conversation turn." }, "assistantSession": { "description": "Required. The assistant session to be used to run the assistant. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}`", "type": "string" }, "attachedGcsUris": { "description": "Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: \"gs://cxas-transient-uploads/uuid/prd.pdf\"", "type": "array", "items": { "type": "string" } }, "message": { "type": "string", "description": "Required. The message to send to the assistant agent." } }, "type": "object", "description": "Request message for AssistantService.ChatAiAssistant." }, "AgentTransfer": { "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.", "type": "string", "readOnly": true } }, "id": "AgentTransfer", "description": "Represents an event indicating the transfer of a conversation to a different agent.", "type": "object" }, "ExperimentConfig": { "id": "ExperimentConfig", "description": "Experiment for the deployment.", "properties": { "versionRelease": { "description": "Optional. Version release for the experiment.", "$ref": "ExperimentConfigVersionRelease" } }, "type": "object" }, "TurnHandoffEvent": { "type": "object", "description": "Emitted before this task stops serving the stream mid-turn (e.g. a server restart). The turn's state is persisted; a reconnect carrying resume_from_sequence_number continues it on another task.", "id": "TurnHandoffEvent", "properties": { "turnId": { "type": "string", "description": "Identifies the turn to resume." }, "reason": { "type": "string", "enum": [ "REASON_UNSPECIFIED", "SERVER_RESTART" ], "enumDescriptions": [ "Unspecified.", "The serving task is shutting down (release push or rescheduling)." ], "description": "Why the stream is handing off." } } }, "LfA2aV1SendMessageRequest": { "type": "object", "description": "Represents a request for the `SendMessage` method.", "id": "LfA2aV1SendMessageRequest", "properties": { "message": { "description": "Required. The message to send to the agent.", "$ref": "LfA2aV1Message" }, "configuration": { "description": "Configuration for the send request.", "$ref": "LfA2aV1SendMessageConfiguration" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "A flexible key-value map for passing additional context or parameters." } } }, "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." }, "SessionConfig": { "type": "object", "description": "The configuration for the session.", "id": "SessionConfig", "properties": { "deployment": { "description": "Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" }, "inputAudioConfig": { "$ref": "InputAudioConfig", "description": "Optional. Configuration for processing the input audio." }, "enableTextStreaming": { "type": "boolean", "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." }, "excludeDiagnosticInfo": { "type": "boolean", "description": "Optional. Whether to exclude diagnostic info from the session output." }, "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" }, "historicalContexts": { "description": "Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.", "items": { "$ref": "Message" }, "type": "array" }, "outputAudioConfig": { "description": "Optional. Configuration for generating the output audio.", "$ref": "OutputAudioConfig" }, "remoteDialogflowQueryParameters": { "$ref": "SessionConfigRemoteDialogflowQueryParameters", "description": "Optional. [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters) to send to the remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent when the session control is transferred to the remote agent." }, "useToolFakes": { "type": "boolean", "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." }, "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" } } }, "Action": { "properties": { "connectionActionId": { "description": "ID of a Connection action for the tool to use.", "type": "string" }, "inputFields": { "type": "array", "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" } }, "entityOperation": { "$ref": "ActionEntityOperation", "description": "Entity operation configuration for the tool to use." }, "outputFields": { "type": "array", "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" } } }, "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.", "type": "object", "id": "Action" }, "EndUserAuthConfigOauth2AuthCodeConfig": { "properties": { "oauthToken": { "type": "string", "description": "Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`." } }, "type": "object", "description": "Oauth 2.0 Authorization Code authentication configuration.", "id": "EndUserAuthConfigOauth2AuthCodeConfig" }, "CitationsCitedChunk": { "type": "object", "id": "CitationsCitedChunk", "description": "Piece of cited information.", "properties": { "uri": { "description": "URI used for citation.", "type": "string" }, "title": { "type": "string", "description": "Title of the cited document." }, "text": { "description": "Text used for citation.", "type": "string" }, "requiresAttribution": { "type": "boolean", "description": "Whether this citation requires attribution to be shown to the end users." } } }, "TypedPayload": { "id": "TypedPayload", "properties": { "displayName": { "description": "Required. The display name of the payload.", "type": "string" }, "value": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Required. The value of the payload.", "type": "object" }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. The metadata of the payload." }, "type": { "type": "string", "description": "Required. The type of the payload." } }, "type": "object", "description": "Payload with a type." }, "ConnectorToolset": { "properties": { "authConfig": { "$ref": "EndUserAuthConfig", "description": "Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the Toolset creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override" }, "connection": { "description": "Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`", "type": "string" }, "connectorActions": { "description": "Required. The list of connector actions/entity operations to generate tools for.", "items": { "$ref": "Action" }, "type": "array" } }, "description": "A toolset that generates tools from an Integration Connectors Connection.", "id": "ConnectorToolset", "type": "object" }, "GenerateAppResourceRequestQualityReportGenerationConfig": { "id": "GenerateAppResourceRequestQualityReportGenerationConfig", "properties": { "algorithm": { "description": "Optional. The loss attribution algorithm to use.", "enumDescriptions": [ "Unspecified.", "App-centric loss attribution. Treats the app as a single unit.", "Agent-centric loss attribution. Attributes loss to individual agents." ], "type": "string", "enum": [ "LOSS_ATTRIBUTION_ALGORITHM_UNSPECIFIED", "APP_CENTRIC", "AGENT_CENTRIC" ] }, "evaluationRun": { "type": "string", "description": "Required. The evaluation run used to inform quality report analysis." } }, "description": "The configuration to be used for quality report generation.", "type": "object" }, "LfA2aV1OAuthFlows": { "id": "LfA2aV1OAuthFlows", "properties": { "implicit": { "$ref": "LfA2aV1ImplicitOAuthFlow", "description": "Deprecated: Use Authorization Code + PKCE instead.", "deprecated": true }, "password": { "$ref": "LfA2aV1PasswordOAuthFlow", "deprecated": true, "description": "Deprecated: Use Authorization Code + PKCE or Device Code." }, "clientCredentials": { "$ref": "LfA2aV1ClientCredentialsOAuthFlow", "description": "Configuration for the OAuth Client Credentials flow." }, "deviceCode": { "$ref": "LfA2aV1DeviceCodeOAuthFlow", "description": "Configuration for the OAuth Device Code flow." }, "authorizationCode": { "$ref": "LfA2aV1AuthorizationCodeOAuthFlow", "description": "Configuration for the OAuth Authorization Code flow." } }, "description": "Defines the configuration for the supported OAuth 2.0 flows.", "type": "object" }, "Evaluation": { "properties": { "lastUpdatedBy": { "readOnly": true, "type": "string", "description": "Output only. The user who last updated the evaluation." }, "evaluationDatasets": { "items": { "type": "string" }, "type": "array", "readOnly": true, "description": "Output only. List of evaluation datasets the evaluation belongs to. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`" }, "etag": { "type": "string", "readOnly": true, "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes." }, "createTime": { "description": "Output only. Timestamp when the evaluation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "evaluationMetricsConfigOverride": { "description": "Optional. Overrides metrics config for this specific evaluation.", "$ref": "EvaluationMetricsConfig" }, "golden": { "$ref": "EvaluationGolden", "description": "Optional. The golden steps to be evaluated." }, "tags": { "description": "Optional. User defined tags to categorize the evaluation.", "items": { "type": "string" }, "type": "array" }, "evaluationMetricsThresholdOverride": { "description": "Optional. Overrides metrics thresholds for this specific evaluation.", "$ref": "EvaluationMetricsThresholds" }, "createdBy": { "description": "Output only. The user who created the evaluation.", "type": "string", "readOnly": true }, "aggregatedMetrics": { "$ref": "AggregatedMetrics", "description": "Output only. The aggregated metrics for this evaluation across all runs.", "readOnly": true }, "description": { "type": "string", "description": "Optional. User-defined description of the evaluation." }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the evaluation was last updated.", "format": "google-datetime" }, "evaluationRuns": { "description": "Output only. The EvaluationRuns that this Evaluation is associated with.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "name": { "description": "Identifier. The unique identifier of this evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "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.", "readOnly": true, "items": { "$ref": "EvaluationResult" }, "type": "array" }, "lastCompletedResult": { "readOnly": true, "$ref": "EvaluationResult", "description": "Output only. The latest evaluation result for this evaluation." }, "invalid": { "description": "Output only. Whether the evaluation is invalid. This can happen if an evaluation is referencing a tool, toolset, or agent that has since been deleted.", "readOnly": true, "type": "boolean" }, "displayName": { "description": "Required. User-defined display name of the evaluation. Unique within an App.", "type": "string" }, "scenario": { "description": "Optional. The config for a scenario.", "$ref": "EvaluationScenario" } }, "id": "Evaluation", "description": "An evaluation represents all of the information needed to simulate and evaluate an agent.", "type": "object" }, "UploadEvaluationAudioResponse": { "description": "Response message for EvaluationService.UploadEvaluationAudio.", "properties": { "audioGcsUri": { "description": "The Google Cloud Storage URI where the uploaded audio file is stored. Format: `gs:///`", "type": "string" }, "duration": { "format": "google-duration", "description": "The duration of the audio.", "type": "string" }, "transcript": { "description": "The transcript of the audio, generated by Cloud Speech-to-Text.", "type": "string" } }, "type": "object", "id": "UploadEvaluationAudioResponse" }, "LfA2aV1Part": { "type": "object", "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. metadata associated with this part." }, "mediaType": { "description": "The `media_type` (MIME type) of the part content (e.g., \"text/plain\", \"application/json\", \"image/png\"). This field is available for all part types.", "type": "string" }, "filename": { "description": "An optional `filename` for the file (e.g., \"document.pdf\").", "type": "string" }, "raw": { "format": "byte", "description": "The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.", "type": "string" }, "text": { "description": "The string content of the `text` part.", "type": "string" }, "data": { "type": "any", "description": "Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null)." }, "url": { "type": "string", "description": "A `url` pointing to the file's content." } }, "id": "LfA2aV1Part", "description": "`Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON)." }, "ExportEvaluationRunsRequest": { "id": "ExportEvaluationRunsRequest", "type": "object", "description": "Request message for EvaluationService.ExportEvaluationRuns.", "properties": { "exportOptions": { "$ref": "ExportOptions", "description": "Optional. The export options for the evaluation runs." }, "names": { "description": "Required. The resource names of the evaluation runs to export.", "type": "array", "items": { "type": "string" } } } }, "TlsConfigCaCert": { "id": "TlsConfigCaCert", "type": "object", "properties": { "displayName": { "type": "string", "description": "Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates." }, "cert": { "format": "byte", "type": "string", "description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile \u003c(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```" } }, "description": "The CA certificate." }, "Changelog": { "id": "Changelog", "type": "object", "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" }, "originalResource": { "readOnly": true, "description": "Output only. The original resource before the change.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "createTime": { "description": "Output only. The time when the change was made.", "readOnly": true, "type": "string", "format": "google-datetime" }, "newResource": { "type": "object", "readOnly": true, "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Output only. The new resource after the change." }, "resource": { "description": "Output only. The resource that was changed.", "type": "string", "readOnly": true }, "author": { "type": "string", "readOnly": true, "description": "Output only. Email address of the change author." }, "dependentResources": { "readOnly": true, "type": "array", "description": "Output only. The dependent resources that were changed.", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "action": { "description": "Output only. The action that was performed on the resource.", "readOnly": true, "type": "string" }, "name": { "description": "Identifier. The unique identifier of the changelog. Format: `projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}`", "type": "string" }, "resourceType": { "description": "Output only. The type of the resource that was changed.", "type": "string", "readOnly": true }, "description": { "readOnly": true, "description": "Output only. Description of the change. which typically captures the changed fields in the resource.", "type": "string" }, "sequenceNumber": { "readOnly": true, "format": "int64", "description": "Output only. The monotonically increasing sequence number of the changelog.", "type": "string" } } }, "LatencyReportGuardrailLatency": { "description": "Latency metrics for a single guardrail.", "properties": { "guardrailDisplayName": { "type": "string", "readOnly": true, "description": "Output only. The display name of the guardrail." }, "guardrail": { "type": "string", "readOnly": true, "description": "Output only. The name of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`." }, "latencyMetrics": { "description": "Output only. The latency metrics for the guardrail.", "$ref": "LatencyReportLatencyMetrics", "readOnly": true } }, "type": "object", "id": "LatencyReportGuardrailLatency" }, "AudioRecordingConfig": { "id": "AudioRecordingConfig", "properties": { "gcsPathPrefix": { "type": "string", "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." }, "gcsBucket": { "type": "string", "description": "Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with \"gs://\". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`." } }, "type": "object", "description": "Configuration for how the audio interactions should be recorded." }, "OptionQuestionsChunkQuestion": { "id": "OptionQuestionsChunkQuestion", "type": "object", "properties": { "question": { "description": "The question header text.", "type": "string" }, "options": { "description": "The selectable options, in presentation order.", "type": "array", "items": { "$ref": "OptionQuestionsChunkOption" } } }, "description": "One question with its options." }, "Empty": { "type": "object", "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" }, "BatchDeleteConversationsResponse": { "type": "object", "properties": { "deletedConversations": { "type": "array", "description": "The list of conversations that were successfully deleted.", "items": { "type": "string" } }, "errorMessages": { "items": { "type": "string" }, "type": "array", "description": "Optional. A list of error messages associated with conversations that failed to be deleted." }, "failedConversations": { "items": { "type": "string" }, "description": "The list of conversations that failed to be deleted.", "type": "array" } }, "description": "Response message for AgentService.BatchDeleteConversations.", "id": "BatchDeleteConversationsResponse" }, "WidgetToolDataMapping": { "id": "WidgetToolDataMapping", "description": "Configuration for mapping data from a source tool to the widget's input parameters.", "properties": { "mode": { "type": "string", "enum": [ "MODE_UNSPECIFIED", "FIELD_MAPPING", "PYTHON_SCRIPT" ], "description": "Optional. The mode of the data mapping.", "enumDescriptions": [ "Unspecified mode.", "Use the `field_mappings` map for data transformation.", "Use the `python_script` for data transformation." ] }, "pythonScript": { "type": "string", "description": "Deprecated: Use `python_function` instead.", "deprecated": true }, "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" }, "fieldMappings": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. A map of widget input parameter fields to the corresponding output fields of the source tool." }, "pythonFunction": { "description": "Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.", "$ref": "PythonFunction" } }, "type": "object" }, "EvaluationScenarioExpectationToolExpectation": { "description": "The tool call and response pair to be evaluated.", "id": "EvaluationScenarioExpectationToolExpectation", "type": "object", "properties": { "expectedToolCall": { "$ref": "ToolCall", "description": "Required. The expected tool call, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM." }, "mockToolResponse": { "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" } } }, "AggregatedMetricsSemanticSimilarityMetrics": { "description": "Metrics for semantic similarity results.", "properties": { "score": { "format": "float", "readOnly": true, "description": "Output only. The average semantic similarity score (0-4).", "type": "number" } }, "type": "object", "id": "AggregatedMetricsSemanticSimilarityMetrics" }, "Agent": { "description": "An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks.", "type": "object", "id": "Agent", "properties": { "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when the agent was last updated.", "type": "string" }, "remoteDialogflowAgent": { "$ref": "AgentRemoteDialogflowAgent", "description": "Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`." }, "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." }, "transferRules": { "items": { "$ref": "TransferRule" }, "description": "Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.", "type": "array" }, "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" }, "childAgents": { "items": { "type": "string" }, "description": "Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "array" }, "guardrails": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`" }, "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" } }, "beforeModelCallbacks": { "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.", "items": { "$ref": "Callback" } }, "remoteA2aAgent": { "description": "Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.", "$ref": "AgentRemoteA2aAgent" }, "instruction": { "description": "Optional. Instructions for the LLM model to guide the agent's behavior.", "type": "string" }, "generatedSummary": { "description": "Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.", "readOnly": true, "type": "string" }, "llmAgent": { "$ref": "AgentLlmAgent", "description": "Optional. The default agent type." }, "tools": { "description": "Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "array", "items": { "type": "string" } }, "toolsets": { "items": { "$ref": "AgentAgentToolset" }, "description": "Optional. List of toolsets for the agent.", "type": "array" }, "description": { "type": "string", "description": "Optional. Human-readable description of the agent." }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when the agent was created.", "type": "string", "readOnly": true }, "beforeAgentCallbacks": { "description": "Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.", "type": "array", "items": { "$ref": "Callback" } }, "name": { "description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "validationErrors": { "items": { "type": "string" }, "type": "array", "description": "Output only. Misconfigurations or errors in the agent that may affect agent quality.", "readOnly": true }, "modelSettings": { "$ref": "ModelSettings", "description": "Optional. Configurations for the LLM model." }, "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." }, "displayName": { "type": "string", "description": "Required. Display name of the agent." }, "afterModelCallbacks": { "items": { "$ref": "Callback" }, "type": "array", "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." } } }, "EvaluationMetricsConfigExpectationsMetMetricsConfig": { "id": "EvaluationMetricsConfigExpectationsMetMetricsConfig", "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.", "type": "object", "properties": { "enableExpectationsMetMetrics": { "description": "Optional. Whether to calculate the expectation level metrics for the evaluation.", "type": "boolean" } } }, "DataStore": { "properties": { "connectorConfig": { "readOnly": true, "description": "Output only. The connector config for the data store connection.", "$ref": "DataStoreConnectorConfig" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the data store was created.", "readOnly": true }, "documentProcessingMode": { "description": "Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.", "enum": [ "DOCUMENT_PROCESSING_MODE_UNSPECIFIED", "DOCUMENTS", "CHUNKS" ], "readOnly": true, "enumDescriptions": [ "Not specified.", "Documents are processed as documents.", "Documents are converted to chunks." ], "type": "string" }, "name": { "description": "Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", "type": "string" }, "displayName": { "description": "Output only. The display name of the data store.", "readOnly": true, "type": "string" }, "type": { "type": "string", "description": "Output only. The type of the data store. This field is readonly and populated by the server.", "readOnly": true, "enumDescriptions": [ "Not specified. This value indicates that the data store type is not specified, so it will not be used during search.", "A data store that contains public web content.", "A data store that contains unstructured private data.", "A data store that contains structured data used as FAQ.", "A data store that is a connector to a first-party or a third-party service." ], "enum": [ "DATA_STORE_TYPE_UNSPECIFIED", "PUBLIC_WEB", "UNSTRUCTURED", "FAQ", "CONNECTOR" ] } }, "id": "DataStore", "description": "A DataStore resource in Vertex AI Search.", "type": "object" }, "EvaluationResult": { "properties": { "evaluationStatus": { "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, "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "type": "string", "description": "Output only. The outcome of the evaluation. Only populated if execution_state is COMPLETE." }, "initiatedBy": { "type": "string", "readOnly": true, "description": "Output only. The user who initiated the evaluation run that resulted in this result." }, "evaluationMetricsThresholds": { "description": "Output only. The evaluation thresholds for the result.", "$ref": "EvaluationMetricsThresholds", "readOnly": true }, "goldenResult": { "description": "Output only. The outcome of a golden evaluation.", "$ref": "EvaluationResultGoldenResult", "readOnly": true }, "error": { "readOnly": true, "deprecated": true, "$ref": "Status", "description": "Output only. Deprecated: Use `error_info` instead. Errors encountered during execution." }, "outcomeMetadata": { "enumDescriptions": [ "Unspecified outcome metadata.", "The evaluation resulted in a graceful handoff to a human representative." ], "description": "Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE.", "type": "string", "readOnly": true, "enum": [ "OUTCOME_METADATA_UNSPECIFIED", "GRACEFUL_HANDOFF" ] }, "displayName": { "type": "string", "description": "Required. Display name of the Evaluation Result. Unique within an Evaluation. By default, it has the following format: \" result - \"." }, "rootSpan": { "$ref": "Span", "description": "Output only. The root span of the evaluation execution, which includes information about each step of the evaluation.", "readOnly": true }, "errorInfo": { "description": "Output only. Error information for the evaluation result.", "readOnly": true, "$ref": "EvaluationErrorInfo" }, "changelog": { "description": "Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.", "type": "string", "readOnly": true }, "changelogCreateTime": { "type": "string", "readOnly": true, "description": "Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.", "format": "google-datetime" }, "executionState": { "readOnly": true, "enum": [ "EXECUTION_STATE_UNSPECIFIED", "QUEUED", "RUNNING", "COMPLETED", "ERROR", "CANCELLED" ], "description": "Output only. The state of the evaluation result execution.", "type": "string", "enumDescriptions": [ "Evaluation result execution state is not specified.", "Evaluation result execution is queued.", "Evaluation result execution is running.", "Evaluation result execution has completed.", "Evaluation result execution failed due to an internal error.", "Evaluation result execution was cancelled." ] }, "appVersionDisplayName": { "readOnly": true, "type": "string", "description": "Output only. The display name of the `app_version` that the evaluation ran against." }, "createTime": { "description": "Output only. Timestamp when the evaluation result was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "persona": { "readOnly": true, "$ref": "EvaluationPersona", "description": "Output only. The persona used to generate the conversation for the evaluation result." }, "evaluationRun": { "type": "string", "readOnly": true, "description": "Output only. The evaluation run that produced this result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`" }, "goldenRunMethod": { "description": "Output only. The method used to run the golden evaluation.", "type": "string", "readOnly": true, "enumDescriptions": [ "Run method is not specified.", "Run the evaluation as stable replay, where each turn is a unique session with the previous expected turns injected as context.", "Run the evaluation as naive replay, where the run is a single session with no context injected." ], "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ] }, "name": { "type": "string", "description": "Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`" }, "config": { "description": "Output only. The configuration used in the evaluation run that resulted in this result.", "readOnly": true, "$ref": "EvaluationConfig" }, "scenarioResult": { "readOnly": true, "$ref": "EvaluationResultScenarioResult", "description": "Output only. The outcome of a scenario evaluation." }, "appVersion": { "type": "string", "description": "Output only. The app version used to generate the conversation that resulted in this result. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "readOnly": true } }, "description": "An evaluation result represents the output of running an Evaluation.", "type": "object", "id": "EvaluationResult" }, "Message": { "properties": { "chunks": { "type": "array", "items": { "$ref": "Chunk" }, "description": "Optional. Content of the message as a series of chunks." }, "role": { "type": "string", "description": "Optional. The role within the conversation, e.g., user, agent." }, "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.", "type": "object", "id": "Message" }, "EvaluationMetricsThresholds": { "properties": { "hallucinationMetricBehavior": { "description": "Optional. Deprecated: Use `golden_hallucination_metric_behavior` instead. The hallucination metric behavior is currently used for golden evaluations.", "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ], "deprecated": true, "type": "string" }, "scenarioHallucinationMetricBehavior": { "description": "Optional. The hallucination metric behavior for scenario evaluations.", "type": "string", "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ] }, "goldenEvaluationMetricsThresholds": { "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds", "description": "Optional. The golden evaluation metrics thresholds." }, "goldenHallucinationMetricBehavior": { "enumDescriptions": [ "Unspecified hallucination metric behavior.", "Disable hallucination metric.", "Enable hallucination metric." ], "description": "Optional. The hallucination metric behavior for golden evaluations.", "type": "string", "enum": [ "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", "DISABLED", "ENABLED" ] } }, "id": "EvaluationMetricsThresholds", "type": "object", "description": "Threshold settings for metrics in an Evaluation." }, "AppVariableDeclaration": { "id": "AppVariableDeclaration", "type": "object", "description": "Defines the structure and metadata for a variable.", "properties": { "schema": { "$ref": "Schema", "description": "Required. The schema of the variable." }, "name": { "type": "string", "description": "Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores." }, "description": { "description": "Required. The description of the variable.", "type": "string" } } }, "RestoreAppVersionRequest": { "properties": {}, "type": "object", "description": "Request message for AgentService.RestoreAppVersion", "id": "RestoreAppVersionRequest" }, "CancelAssistantTurnRequest": { "description": "Request to cancel an assistant session's in-flight turn.", "properties": { "turnId": { "description": "Optional. The turn to cancel; empty cancels whichever turn is running. A cancel naming a turn that is no longer the running one is a no-op.", "type": "string" } }, "id": "CancelAssistantTurnRequest", "type": "object" }, "RunAssistantRequest": { "type": "object", "id": "RunAssistantRequest", "properties": { "message": { "description": "Required. The message to send to the assistant agent.", "$ref": "AssistantMessage" }, "interactionType": { "enumDescriptions": [ "The default value. This value is used if the type is not specified.", "The message is a user input. User input is provided in the chunk list.", "The message is for polling the state of the assistant session.", "The message is to dismiss the assistant session pending review. This will change the state of the assistant session to idle." ], "description": "Optional. Different interaction types for the assistant message.", "type": "string", "enum": [ "INTERACTION_TYPE_UNSPECIFIED", "NEW_MESSAGE", "POLL", "DISMISS" ] }, "assistantSession": { "description": "Required. The assistant session to be used to run the assistant. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}`", "type": "string" } }, "description": "Request message for AssistantService.RunAssistant." }, "TriggerActionGenerativeAnswer": { "properties": { "prompt": { "type": "string", "description": "Required. The prompt to use for the generative answer." } }, "id": "TriggerActionGenerativeAnswer", "description": "The agent will immediately respond with a generative answer.", "type": "object" }, "DataStoreToolRewriterConfig": { "type": "object", "description": "Rewriter configuration.", "properties": { "modelSettings": { "$ref": "ModelSettings", "description": "Required. Configurations for the LLM model." }, "disabled": { "description": "Optional. Whether the rewriter is disabled.", "type": "boolean" }, "prompt": { "description": "Optional. The prompt definition. If not set, default prompt will be used.", "type": "string" } }, "id": "DataStoreToolRewriterConfig" }, "WidgetTool": { "properties": { "textResponseConfig": { "$ref": "WidgetToolTextResponseConfig", "description": "Optional. Configuration for always-included text responses." }, "dataMapping": { "description": "Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.", "$ref": "WidgetToolDataMapping" }, "description": { "description": "Optional. The description of the widget tool.", "type": "string" }, "name": { "description": "Required. The display name of the widget tool.", "type": "string" }, "uiConfig": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Configuration for rendering the widget." }, "parameters": { "description": "Optional. The input parameters of the widget tool.", "$ref": "Schema" }, "widgetType": { "type": "string", "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": "Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.", "enumDescriptions": [ "Unspecified widget type.", "Custom widget type.", "Product carousel widget.", "Product details widget.", "Quick actions widget.", "Product comparison widget.", "Advanced product details widget.", "Short form widget.", "Overall satisfaction widget.", "Order summary widget.", "Appointment details widget.", "Appointment scheduler widget.", "Contact form widget." ] } }, "description": "Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.", "id": "WidgetTool", "type": "object" }, "ClientFunction": { "type": "object", "id": "ClientFunction", "properties": { "response": { "$ref": "Schema", "description": "Optional. The schema of the function response." }, "description": { "description": "Optional. The function description.", "type": "string" }, "parameters": { "$ref": "Schema", "description": "Optional. The schema of the function parameters." }, "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." }, "EvaluationMetricsConfigGoldenMetricsConfig": { "properties": { "stepToolCorrectnessMetricsConfig": { "description": "Optional. Configuration for step level tool correctness metrics.", "$ref": "EvaluationMetricsConfigToolCorrectnessMetricsConfig" }, "toolCorrectnessMetricsConfig": { "description": "Optional. Configuration for turn level tool correctness metrics.", "$ref": "EvaluationMetricsConfigToolCorrectnessMetricsConfig" }, "semanticSimilarityMetricsConfig": { "description": "Optional. Global configuration for semantic similarity metrics.", "$ref": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig" } }, "id": "EvaluationMetricsConfigGoldenMetricsConfig", "type": "object", "description": "Configuration for the golden metrics for the evaluation." }, "DataStoreToolGroundingConfig": { "properties": { "disabled": { "description": "Optional. Whether grounding is disabled.", "type": "boolean" }, "groundingLevel": { "format": "float", "type": "number", "description": "Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned." } }, "id": "DataStoreToolGroundingConfig", "description": "Grounding configuration.", "type": "object" }, "WhatsAppCredentials": { "description": "Ephemeral Meta credentials for WhatsApp native integration.", "properties": { "wabaId": { "type": "string", "description": "Required. The WhatsApp Business Account ID." }, "pin": { "description": "Required. The 6-digit PIN created by the user for two-step verification.", "type": "string" }, "phoneNumber": { "description": "Required. The phone number to register with WhatsApp.", "type": "string" }, "conversationProfileId": { "description": "Optional. The Conversation Profile ID to use for the deployment.", "type": "string" }, "businessAccountId": { "type": "string", "description": "Required. The Business Account ID to use for the phone number." }, "authCode": { "type": "string", "description": "Required. The Meta auth code provided by the embedded signup flow." } }, "type": "object", "id": "WhatsAppCredentials" }, "LfA2aV1SendMessageResponse": { "id": "LfA2aV1SendMessageResponse", "type": "object", "description": "Represents the response for the `SendMessage` method.", "properties": { "task": { "$ref": "LfA2aV1Task", "description": "The task created or updated by the message." }, "message": { "$ref": "LfA2aV1Message", "description": "A message from the agent." } } }, "ToolCalls": { "properties": { "toolCalls": { "description": "Optional. The list of tool calls to execute.", "items": { "$ref": "ToolCall" }, "type": "array" } }, "id": "ToolCalls", "description": "Request for the client to execute the tools and return the execution results before continuing the session.", "type": "object" }, "GoogleSearchSuggestions": { "properties": { "htmls": { "description": "Compliant HTML and CSS styling for search suggestions. The provided HTML and CSS automatically adapts to your device settings, displaying in either light or dark mode indicated by `@media(prefers-color-scheme)`.", "type": "array", "items": { "type": "string" } }, "webSearchQueries": { "type": "array", "items": { "$ref": "WebSearchQuery" }, "description": "List of queries used to perform the google search along with the search result URIs forming the search suggestions." } }, "id": "GoogleSearchSuggestions", "type": "object", "description": "Search suggestions from Google Search Tool." }, "EvaluationMetricsConfigHallucinationMetricsConfig": { "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.", "properties": { "enableHallucinationMetrics": { "type": "boolean", "description": "Optional. Whether to calculate hallucination metrics for the evaluation." } }, "id": "EvaluationMetricsConfigHallucinationMetricsConfig", "type": "object" }, "ExpressionCondition": { "properties": { "expression": { "type": "string", "description": "Required. The string representation of cloud.api.Expression condition." } }, "description": "Expression condition based on session state.", "type": "object", "id": "ExpressionCondition" }, "SessionOutput": { "description": "Output for the session.", "properties": { "citations": { "description": "Citations that provide the source information for the agent's generated text.", "$ref": "Citations" }, "googleSearchSuggestions": { "$ref": "GoogleSearchSuggestions", "description": "The suggestions returned from Google Search as a result of invoking the GoogleSearchTool." }, "payload": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Custom payload with structured output from the CES agent." }, "text": { "type": "string", "description": "Output text from the CES agent." }, "audio": { "description": "Output audio from the CES agent.", "format": "byte", "type": "string" }, "turnIndex": { "format": "int32", "description": "Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.", "type": "integer" }, "progress": { "description": "Intermediate progress update from the CES agent.", "type": "string" }, "image": { "$ref": "Image", "description": "Output image from the CES agent." }, "endSession": { "description": "Indicates the session has ended.", "$ref": "EndSession" }, "turnCompleted": { "type": "boolean", "description": "If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn." }, "diagnosticInfo": { "$ref": "SessionOutputDiagnosticInfo", "description": "Optional. Diagnostic information contains execution details during the processing of the input. Only populated in the last SessionOutput (with `turn_completed=true`) for each turn." }, "toolCalls": { "$ref": "ToolCalls", "description": "Request for the client to execute the tools." } }, "type": "object", "id": "SessionOutput" }, "ImportAppResponse": { "type": "object", "id": "ImportAppResponse", "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." }, "DataStoreConnectorConfig": { "description": "The connector config for the data store connection.", "properties": { "collection": { "type": "string", "description": "Resource name of the collection the data store belongs to." }, "dataSource": { "description": "The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.", "type": "string" }, "collectionDisplayName": { "type": "string", "description": "Display name of the collection the data store belongs to." } }, "id": "DataStoreConnectorConfig", "type": "object" }, "ImportEvaluationsRequestImportOptions": { "id": "ImportEvaluationsRequestImportOptions", "type": "object", "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": { "description": "Optional. The strategy to use when resolving conflicts during import.", "type": "string", "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." ] } } }, "ListAssistantSessionsResponse": { "description": "Response message for AssistantService.ListAssistantSessions.", "type": "object", "properties": { "assistantSessions": { "type": "array", "description": "The list of assistant sessions.", "items": { "$ref": "AssistantSession" } }, "nextPageToken": { "description": "Optional. A token that can be sent as ListAssistantSessionsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } }, "id": "ListAssistantSessionsResponse" }, "EvaluationResultOverallToolInvocationResult": { "description": "The result of the overall tool invocation check.", "type": "object", "properties": { "toolInvocationScore": { "type": "number", "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." }, "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." ], "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "readOnly": true, "type": "string", "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." } }, "id": "EvaluationResultOverallToolInvocationResult" }, "ListConversationsResponse": { "type": "object", "description": "Response message for AgentService.ListConversations.", "properties": { "conversations": { "items": { "$ref": "Conversation" }, "description": "The list of conversations.", "type": "array" }, "nextPageToken": { "description": "A token that can be sent as ListConversationsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } }, "id": "ListConversationsResponse" }, "DataStoreSettingsEngine": { "properties": { "name": { "description": "Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string", "readOnly": true }, "type": { "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." ], "enum": [ "TYPE_UNSPECIFIED", "ENGINE_TYPE_SEARCH", "ENGINE_TYPE_CHAT" ], "readOnly": true, "type": "string", "description": "Output only. The type of the engine." } }, "type": "object", "description": "An engine to which the data stores are connected. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.", "id": "DataStoreSettingsEngine" }, "DataStoreSettings": { "description": "Data store related settings for the app.", "properties": { "engines": { "description": "Output only. The engines for the app.", "items": { "$ref": "DataStoreSettingsEngine" }, "readOnly": true, "type": "array" } }, "type": "object", "id": "DataStoreSettings" }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "type": "object" }, "GuardrailSupervisor": { "properties": { "detectionMode": { "description": "Optional. The detection mode of the supervisor.", "type": "string", "enum": [ "DETECTION_MODE_UNSPECIFIED", "NON_BLOCKING", "BLOCKING" ], "enumDescriptions": [ "Detection mode is unspecified. Default to NON_BLOCKING.", "Non blocking detection mode. Response is not blocked when the supervisor detection is ongoing.", "Blocking detection mode. Response is blocked when the supervisor detection is ongoing." ] }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "INVALID_TEXT", "LANGUAGE_SHIFT", "SPEAKER_SHIFT", "AUDIO_MISMATCH", "MISSING_TOOL_CALL", "CUSTOM", "CHOPPY_AUDIO", "PROFANITY" ], "description": "Optional. The type of the supervisor.", "enumDescriptions": [ "Type is unspecified.", "Invalid text issue type.", "Language shift issue type.", "Speaker shift issue type.", "Audio mismatch issue type.", "Missing tool call issue type.", "Custom issue type.", "Choppy audio issue type.", "Agent profanity issue type." ] } }, "description": "Guardrail that runs supervisor intervention.", "id": "GuardrailSupervisor", "type": "object" }, "ExportEvaluationResultsRequest": { "description": "Request message for EvaluationService.ExportEvaluationResults.", "type": "object", "properties": { "exportOptions": { "description": "Optional. The export options for the evaluation results.", "$ref": "ExportOptions" }, "names": { "items": { "type": "string" }, "type": "array", "description": "Required. The resource names of the evaluation results to export." } }, "id": "ExportEvaluationResultsRequest" }, "TurnCompletedEvent": { "description": "Terminal event of a turn (see StreamChatAiAssistantResponse.turn_completed).", "id": "TurnCompletedEvent", "type": "object", "properties": { "finalSequenceNumber": { "type": "string", "description": "Sequence number of the last event the turn produced. A client whose cursor is lower missed content and should reload the session to see it.", "format": "int64" }, "turnId": { "description": "Identifier of the turn that ended; matches TurnResumeSnapshot.turn_id and ActiveTurnInfo.turn_id.", "type": "string" }, "reason": { "type": "string", "enum": [ "REASON_UNSPECIFIED", "COMPLETED", "ABANDONED", "RESUME_UNAVAILABLE" ], "description": "Why the turn ended.", "enumDescriptions": [ "Unspecified.", "The turn ran to completion; the session holds its committed output.", "No task was driving the turn any more; it was sealed to a committed partial and cannot be continued.", "This server does not serve attach or resume for the session, so nothing was tailed; the client should reload the session instead." ] } } }, "AmbientSoundConfig": { "description": "Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.", "properties": { "volumeGainDb": { "description": "Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.", "type": "number", "format": "double" }, "prebuiltAmbientNoise": { "type": "string", "enumDescriptions": [ "Not specified.", "Ambient noise of a retail store.", "Ambient noise of a convention hall.", "Ambient noise of a street." ], "deprecated": true, "description": "Optional. Deprecated: `prebuilt_ambient_noise` is deprecated in favor of `prebuilt_ambient_sound`.", "enum": [ "PREBUILT_AMBIENT_NOISE_UNSPECIFIED", "RETAIL_STORE", "CONVENTION_HALL", "OUTDOOR" ] }, "prebuiltAmbientSound": { "description": "Optional. Name of the prebuilt ambient sound. Valid values are: - \"coffee_shop\" - \"keyboard\" - \"keypad\" - \"hum\" - \"office_1\" - \"office_2\" - \"office_3\" - \"room_1\" - \"room_2\" - \"room_3\" - \"room_4\" - \"room_5\" - \"air_conditioner\"", "type": "string" }, "gcsUri": { "description": "Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in [Cloud Storage](https://cloud.google.com/storage). Note: Please make sure the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object.", "type": "string" } }, "type": "object", "id": "AmbientSoundConfig" }, "EvaluationResultGoldenExpectationOutcomeToolInvocationResult": { "id": "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": { "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 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": { "type": "string", "description": "Output only. A free text explanation for the tool invocation result.", "readOnly": true } }, "description": "The result of the tool invocation check.", "type": "object" }, "ListEvaluationResultsResponse": { "id": "ListEvaluationResultsResponse", "description": "Response message for EvaluationService.ListEvaluationResults.", "type": "object", "properties": { "evaluationResults": { "items": { "$ref": "EvaluationResult" }, "type": "array", "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" } } }, "AggregatedMetrics": { "properties": { "metricsByAppVersion": { "readOnly": true, "items": { "$ref": "AggregatedMetricsMetricsByAppVersion" }, "description": "Output only. Aggregated metrics, grouped by app version ID.", "type": "array" } }, "id": "AggregatedMetrics", "description": "Aggregated metrics for an evaluation or evaluation dataset.", "type": "object" }, "AppVersion": { "type": "object", "id": "AppVersion", "properties": { "name": { "description": "Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "etag": { "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.", "readOnly": true }, "createTime": { "description": "Output only. Timestamp when the app version was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "displayName": { "description": "Optional. The display name of the app version.", "type": "string" }, "creator": { "readOnly": true, "type": "string", "description": "Output only. Email of the user who created the app version." }, "snapshot": { "description": "Output only. The snapshot of the app when the version is created.", "readOnly": true, "$ref": "AppSnapshot" }, "description": { "description": "Optional. The description of the app version.", "type": "string" }, "updateTime": { "type": "string", "description": "Output only. Timestamp when the app version was last updated.", "format": "google-datetime", "readOnly": true } }, "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." }, "ChannelProfileInstagramConfig": { "id": "ChannelProfileInstagramConfig", "properties": { "description": { "readOnly": true, "type": "string", "description": "Output only. The description of the Meta business page or profile." }, "thumbnailUrl": { "readOnly": true, "description": "Output only. The fetched Meta business profile thumbnail URL.", "type": "string" }, "instagramAccountId": { "description": "Required. The Instagram Account ID.", "type": "string" }, "displayName": { "description": "Output only. The fetched Meta business page name.", "type": "string", "readOnly": true } }, "description": "Configuration specific to Instagram deployments.", "type": "object" }, "ListScheduledEvaluationRunsResponse": { "type": "object", "id": "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." }, "ServiceAgentIdTokenAuthConfig": { "properties": {}, "id": "ServiceAgentIdTokenAuthConfig", "description": "Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent.", "type": "object" }, "ChannelProfileWebWidgetConfigSecuritySettings": { "id": "ChannelProfileWebWidgetConfigSecuritySettings", "description": "Security settings for the web widget.", "type": "object", "properties": { "allowedOrigins": { "description": "Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: \"https://example.com\"", "type": "array", "items": { "type": "string" } }, "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" }, "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" } } }, "ConnectorTool": { "description": "A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview.", "id": "ConnectorTool", "properties": { "name": { "description": "Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.", "type": "string" }, "description": { "type": "string", "description": "Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool." }, "action": { "description": "Required. Action for the tool to use.", "$ref": "Action" }, "connection": { "description": "Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`", "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" } }, "type": "object" }, "ServiceDirectoryConfig": { "id": "ServiceDirectoryConfig", "properties": { "service": { "description": "Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.", "type": "string" } }, "description": "Configuration for tools using Service Directory.", "type": "object" }, "ErrorHandlingSettingsFallbackResponseConfig": { "id": "ErrorHandlingSettingsFallbackResponseConfig", "description": "Configuration for handling fallback responses.", "properties": { "maxFallbackAttempts": { "format": "int32", "description": "Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.", "type": "integer" }, "customFallbackMessages": { "description": "Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language).", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object" }, "App": { "type": "object", "properties": { "evaluationSettings": { "description": "Optional. The evaluation settings for the app.", "$ref": "EvaluationSettings" }, "timeZoneSettings": { "description": "Optional. TimeZone settings of the app.", "$ref": "TimeZoneSettings" }, "toolExecutionMode": { "description": "Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.", "enumDescriptions": [ "Unspecified tool execution mode. Default to PARALLEL.", "If there are multiple tools being selected, they will be executed in parallel, with the same [ToolContext](https://google.github.io/adk-docs/context/#the-different-types-of-context).", "If there are multiple tools being selected, they will be executed sequentially. The next tool will only be executed after the previous tool completes and it can see updated [ToolContext](https://google.github.io/adk-docs/context/#the-different-types-of-context) from the previous tool." ], "type": "string", "enum": [ "TOOL_EXECUTION_MODE_UNSPECIFIED", "PARALLEL", "SEQUENTIAL" ] }, "evaluationMetricsThresholds": { "$ref": "EvaluationMetricsThresholds", "description": "Optional. The evaluation thresholds for the app." }, "locked": { "description": "Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.", "type": "boolean" }, "evaluationPersonas": { "type": "array", "description": "Optional. The evaluation personas for the app. This field is used to define the personas that can be used for evaluation. Maximum of 30 personas can be defined.", "items": { "$ref": "EvaluationPersona" } }, "clientCertificateSettings": { "description": "Optional. The default client certificate settings for the app.", "$ref": "ClientCertificateSettings" }, "defaultChannelProfile": { "description": "Optional. The default channel profile used by the app.", "$ref": "ChannelProfile" }, "pinned": { "description": "Optional. Whether the app is pinned in the app list.", "type": "boolean" }, "variableDeclarations": { "items": { "$ref": "AppVariableDeclaration" }, "description": "Optional. The declarations of the variables.", "type": "array" }, "loggingSettings": { "description": "Optional. Logging settings of the app.", "$ref": "LoggingSettings" }, "rootAgent": { "type": "string", "description": "Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`" }, "vpcScSettings": { "description": "Optional. VPC-SC settings for the app.", "$ref": "VpcScSettings" }, "predefinedVariableDeclarations": { "items": { "$ref": "AppVariableDeclaration" }, "type": "array", "description": "Output only. The declarations of predefined variables for the app.", "readOnly": true }, "description": { "description": "Optional. Human-readable description of the app.", "type": "string" }, "validationErrors": { "type": "array", "readOnly": true, "description": "Output only. Misconfigurations or warnings in the app.", "items": { "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.", "type": "string", "readOnly": true }, "dashboardSettings": { "description": "Optional. App-specific dashboard settings for linking and configuring Contact Center Insights dashboards.", "$ref": "DashboardSettings" }, "deploymentCount": { "format": "int32", "readOnly": true, "description": "Output only. Number of deployments in the app.", "type": "integer" }, "audioProcessingConfig": { "$ref": "AudioProcessingConfig", "description": "Optional. Audio processing configuration of the app." }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the app was created." }, "errorHandlingSettings": { "$ref": "ErrorHandlingSettings", "description": "Optional. Error handling settings of the app." }, "modelSettings": { "$ref": "ModelSettings", "description": "Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed." }, "guardrails": { "items": { "type": "string" }, "type": "array", "description": "Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`" }, "name": { "description": "Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`", "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" }, "languageSettings": { "description": "Optional. Language settings of the app.", "$ref": "LanguageSettings" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.", "type": "object" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when the app was last updated.", "type": "string" }, "dataStoreSettings": { "description": "Optional. The data store settings for the app.", "$ref": "DataStoreSettings" }, "displayName": { "type": "string", "description": "Required. Display name of the app." } }, "description": "An app serves as a top-level container for a group of agents, including the root agent and its sub-agents, along with their associated configurations. These agents work together to achieve specific goals within the app's context.", "id": "App" }, "EvaluationResultScenarioExpectationOutcomeObservedToolCall": { "description": "The observed tool call and response.", "properties": { "toolCall": { "description": "Output only. The observed tool call.", "readOnly": true, "$ref": "ToolCall" }, "toolResponse": { "$ref": "ToolResponse", "description": "Output only. The observed tool response.", "readOnly": true } }, "type": "object", "id": "EvaluationResultScenarioExpectationOutcomeObservedToolCall" }, "Deployment": { "type": "object", "properties": { "whatsappCredentials": { "$ref": "WhatsAppCredentials", "description": "Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile." }, "channelProfile": { "description": "Required. The channel profile used in the deployment.", "$ref": "ChannelProfile" }, "appVersion": { "type": "string", "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." }, "displayName": { "type": "string", "description": "Required. Display name of the deployment." }, "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": { "type": "string", "description": "Output only. Timestamp when this deployment was created.", "readOnly": true, "format": "google-datetime" }, "instagramCredentials": { "description": "Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile.", "$ref": "InstagramCredentials" }, "modelSettings": { "description": "Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field.", "$ref": "ModelSettings" }, "agentRegistryDeployment": { "$ref": "AgentRegistryDeployment", "description": "Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry." }, "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" }, "updateTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Timestamp when this deployment was last updated." }, "modality": { "enumDescriptions": [ "Unknown modality.", "Text modality.", "Voice modality.", "Video modality." ], "description": "Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field.", "type": "string", "enum": [ "MODALITY_UNSPECIFIED", "MODALITY_TEXT", "MODALITY_VOICE", "MODALITY_VIDEO" ] } }, "description": "A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.", "id": "Deployment" }, "EvaluationScenarioUserFact": { "id": "EvaluationScenarioUserFact", "properties": { "value": { "type": "string", "description": "Required. The value of the user fact." }, "name": { "description": "Required. The name of the user fact.", "type": "string" } }, "type": "object", "description": "Facts about the user as a key value pair." }, "FileContextFileBytes": { "id": "FileContextFileBytes", "description": "File provided as raw bytes.", "type": "object", "properties": { "fileName": { "description": "Required. The name of the file provided as raw bytes.", "type": "string" }, "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" }, "data": { "description": "Required. Raw bytes of the file.", "type": "string", "format": "byte" } } }, "EvaluationStep": { "id": "EvaluationStep", "type": "object", "properties": { "expectation": { "description": "Optional. Executes an expectation on the current turn.", "$ref": "EvaluationGoldenExpectation" }, "userInput": { "description": "Optional. User input for the conversation.", "$ref": "SessionInput" }, "agentTransfer": { "$ref": "AgentTransfer", "description": "Optional. Transfer the conversation to a different agent." } }, "description": "A step defines a singular action to happen during the evaluation." }, "AssistantSuggestionLoadSession": { "properties": { "assistantSessionId": { "type": "string", "description": "Identifier of the assistant session to open (the final segment of the AssistantSession resource name)." } }, "id": "AssistantSuggestionLoadSession", "type": "object", "description": "Parameters for the load_session action." }, "VpcScSettings": { "type": "object", "id": "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." }, "GuardrailModelSafetySafetySetting": { "properties": { "category": { "enumDescriptions": [ "The harm category is unspecified.", "The harm category is hate speech.", "The harm category is dangerous content.", "The harm category is harassment.", "The harm category is sexually explicit content.", "The harm category is profanity.", "The harm category is toxic." ], "description": "Required. The harm category.", "type": "string", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_PROFANITY", "HARM_CATEGORY_TOXIC" ] }, "threshold": { "enumDescriptions": [ "Unspecified harm block threshold.", "Block low threshold and above (i.e. block more).", "Block medium threshold and above.", "Block only high threshold (i.e. block less).", "Block none.", "Turn off the safety filter." ], "description": "Required. The harm block threshold.", "type": "string", "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", "BLOCK_NONE", "OFF" ] } }, "id": "GuardrailModelSafetySafetySetting", "type": "object", "description": "Safety setting." }, "AggregatedMetricsHallucinationMetrics": { "properties": { "score": { "format": "float", "description": "Output only. The average hallucination score (0 to 1).", "type": "number", "readOnly": true } }, "id": "AggregatedMetricsHallucinationMetrics", "description": "Metrics for hallucination results.", "type": "object" }, "DataStoreTool": { "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.", "type": "object", "properties": { "name": { "description": "Required. The data store tool name.", "type": "string" }, "description": { "description": "Optional. The tool description.", "type": "string" }, "filterParameterBehavior": { "description": "Optional. The filter parameter behavior.", "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", "enum": [ "FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED", "ALWAYS_INCLUDE", "NEVER_INCLUDE" ] }, "dataStoreSource": { "description": "Optional. Search within a single specific DataStore.", "$ref": "DataStoreToolDataStoreSource" }, "modalityConfigs": { "type": "array", "items": { "$ref": "DataStoreToolModalityConfig" }, "description": "Optional. The modality configs for the data store." }, "boostSpecs": { "type": "array", "description": "Optional. Boost specification to boost certain documents.", "items": { "$ref": "DataStoreToolBoostSpecs" } }, "engineSource": { "$ref": "DataStoreToolEngineSource", "description": "Optional. Search within an Engine (potentially across multiple DataStores)." } } }, "CancelAssistantTurnResponse": { "description": "Response for CancelAssistantTurn.", "type": "object", "id": "CancelAssistantTurnResponse", "properties": { "cancelled": { "description": "Whether an in-flight turn was found and asked to stop (directly on this task, or through an epoch preemption for a turn hosted elsewhere).", "type": "boolean" } } }, "ImportEvaluationsResponse": { "description": "Response message for EvaluationService.ImportEvaluations.", "type": "object", "id": "ImportEvaluationsResponse", "properties": { "evaluationResults": { "description": "The list of evaluation results that were imported into the app.", "items": { "$ref": "EvaluationResult" }, "type": "array" }, "evaluationRuns": { "type": "array", "items": { "$ref": "EvaluationRun" }, "description": "The list of evaluation runs that were imported into the app." }, "evaluations": { "description": "The list of evaluations that were imported into the app.", "items": { "$ref": "Evaluation" }, "type": "array" }, "importFailureCount": { "type": "integer", "format": "int32", "description": "The number of evaluations that either failed to import entirely or completed import with one or more errors." }, "evaluationRunImportFailureCount": { "format": "int32", "description": "The number of evaluation runs that either failed to import entirely or completed import with one or more errors.", "type": "integer" }, "errorMessages": { "description": "Optional. A list of error messages associated with evaluations that failed to be imported.", "type": "array", "items": { "type": "string" } }, "evaluationResultImportFailureCount": { "description": "The number of evaluation results that either failed to import entirely or completed import with one or more errors.", "type": "integer", "format": "int32" } } }, "OpenApiTool": { "description": "A remote API tool defined by an OpenAPI schema.", "id": "OpenApiTool", "type": "object", "properties": { "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" }, "name": { "type": "string", "description": "Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`." }, "tlsConfig": { "$ref": "TlsConfig", "description": "Optional. The TLS configuration. Includes the custom server certificates that the client will trust." }, "openApiSchema": { "type": "string", "description": "Required. The OpenAPI schema in JSON or YAML format." }, "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" }, "apiAuthentication": { "$ref": "ApiAuthentication", "description": "Optional. Authentication information required by the API." }, "ignoreUnknownFields": { "description": "Optional. If true, the agent will ignore unknown fields in the API response.", "type": "boolean" } } }, "LfA2aV1AuthorizationCodeOAuthFlow": { "description": "Defines configuration details for the OAuth 2.0 Authorization Code flow.", "id": "LfA2aV1AuthorizationCodeOAuthFlow", "type": "object", "properties": { "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "scopes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Required. The available scopes for the OAuth2 security scheme." }, "pkceRequired": { "type": "boolean", "description": "Indicates if PKCE (RFC 7636) is required for this flow. PKCE should always be used for public clients and is recommended for all clients." }, "tokenUrl": { "type": "string", "description": "Required. The token URL to be used for this flow." }, "authorizationUrl": { "type": "string", "description": "Required. The authorization URL to be used for this flow." } } }, "RetrieveToolSchemaResponse": { "properties": { "tool": { "type": "string", "description": "The name of the tool that the schema is for. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`" }, "inputSchema": { "$ref": "Schema", "description": "The schema of the tool input parameters." }, "toolsetTool": { "$ref": "ToolsetTool", "description": "The toolset tool that the schema is for." }, "outputSchema": { "description": "The schema of the tool output parameters.", "$ref": "Schema" } }, "type": "object", "description": "Response message for ToolService.RetrieveToolSchema.", "id": "RetrieveToolSchemaResponse" }, "LfA2aV1AuthenticationInfo": { "description": "Defines authentication details, used for push notifications.", "id": "LfA2aV1AuthenticationInfo", "type": "object", "properties": { "credentials": { "description": "Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).", "type": "string" }, "scheme": { "type": "string", "description": "Required. HTTP Authentication Scheme from the [IANA registry](https://www.iana.org/assignments/http-authschemes/). Examples: `Bearer`, `Basic`, `Digest`. Scheme names are case-insensitive per [RFC 9110 Section 11.1](https://www.rfc-editor.org/rfc/rfc9110#section-11.1)." } } }, "LoggingSettings": { "type": "object", "properties": { "audioRecordingConfig": { "description": "Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig.", "$ref": "AudioRecordingConfig" }, "unredactedBigqueryExportSettings": { "description": "Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled.", "$ref": "BigQueryExportSettings" }, "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" }, "redactionConfig": { "description": "Optional. Configuration for how sensitive data should be redacted.", "$ref": "RedactionConfig" }, "conversationLoggingSettings": { "description": "Optional. Settings to describe the conversation logging behaviors for the app.", "$ref": "ConversationLoggingSettings" }, "cloudLoggingSettings": { "description": "Optional. Settings to describe the Cloud Logging behaviors for the app.", "$ref": "CloudLoggingSettings" }, "unredactedAudioRecordingConfig": { "$ref": "AudioRecordingConfig", "description": "Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes." }, "bigqueryExportSettings": { "$ref": "BigQueryExportSettings", "description": "Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig." }, "metricAnalysisSettings": { "description": "Optional. Settings to describe the conversation data collection behaviors for the LLM analysis pipeline for the app.", "$ref": "MetricAnalysisSettings" } }, "description": "Settings to describe the logging behaviors for the app.", "id": "LoggingSettings" }, "QualityReportAgentIssues": { "type": "object", "id": "QualityReportAgentIssues", "description": "Issues identified for a single agent.", "properties": { "issues": { "description": "Optional. List of issues found for this agent.", "items": { "$ref": "QualityReportIssue" }, "type": "array" }, "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" } } }, "LfA2aV1Artifact": { "id": "LfA2aV1Artifact", "type": "object", "properties": { "name": { "description": "A human readable name for the artifact.", "type": "string" }, "metadata": { "description": "Optional. Metadata included with the artifact.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "description": { "description": "Optional. A human readable description of the artifact.", "type": "string" }, "extensions": { "items": { "type": "string" }, "type": "array", "description": "The URIs of extensions that are present or contributed to this Artifact." }, "parts": { "type": "array", "items": { "$ref": "LfA2aV1Part" }, "description": "Required. The content of the artifact. Must contain at least one part." }, "artifactId": { "description": "Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.", "type": "string" } }, "description": "Artifacts represent task outputs." }, "EvaluationMetricsConfigScenarioMetricsConfig": { "id": "EvaluationMetricsConfigScenarioMetricsConfig", "type": "object", "description": "Configuration for the scenario metrics for the evaluation.", "properties": { "expectationsMetMetricsConfig": { "$ref": "EvaluationMetricsConfigExpectationsMetMetricsConfig", "description": "Optional. Configuration for expectation level metrics." }, "userGoalMetMetricsConfig": { "description": "Optional. Configuration for user goal met metrics.", "$ref": "EvaluationMetricsConfigUserGoalMetMetricsConfig" } } }, "ExperimentConfigVersionRelease": { "description": "Version release for the experiment.", "properties": { "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "DONE", "EXPIRED" ], "enumDescriptions": [ "Unspecified state.", "Deprecated: This state is no longer used.", "Running state. Experiment is running and valid.", "Deprecated: This state is no longer used.", "Deprecated: This state is no longer used." ], "description": "Optional. State of the version release." }, "trafficAllocations": { "items": { "$ref": "ExperimentConfigVersionReleaseTrafficAllocation" }, "type": "array", "description": "Optional. Traffic allocations for the version release." } }, "id": "ExperimentConfigVersionRelease", "type": "object" }, "ExecuteToolResponse": { "id": "ExecuteToolResponse", "properties": { "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": { "description": "Properties of the object.", "type": "any" } }, "citations": { "$ref": "Citations", "description": "Citations that provide the source information for the tool's execution." }, "toolsetTool": { "description": "The toolset tool that got executed.", "$ref": "ToolsetTool" }, "tool": { "type": "string", "description": "The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`" }, "variables": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The variable values at the end of the tool execution.", "type": "object" }, "googleSearchSuggestions": { "description": "The suggestions returned from Google Search as a result of invoking the Google Search Tool during the tool execution.", "$ref": "GoogleSearchSuggestions" } }, "description": "Response message for ToolService.ExecuteTool.", "type": "object" }, "ScheduledEvaluationRunSchedulingConfig": { "description": "Eval scheduling configuration details", "type": "object", "properties": { "startTime": { "type": "string", "format": "google-datetime", "description": "Required. Timestamp when the eval should start." }, "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": { "format": "int32", "type": "integer" } }, "frequency": { "description": "Required. The frequency with which to run the eval", "type": "string", "enum": [ "FREQUENCY_UNSPECIFIED", "NONE", "DAILY", "WEEKLY", "BIWEEKLY" ], "enumDescriptions": [ "The frequency is unspecified.", "Indicates a one-time scheduled run that should not repeat", "Run the evaluation daily.", "Run the evaluation weekly.", "Run the evaluation biweekly." ] } }, "id": "ScheduledEvaluationRunSchedulingConfig" }, "AggregatedMetricsToolMetrics": { "id": "AggregatedMetricsToolMetrics", "properties": { "tool": { "description": "Output only. The name of the tool.", "readOnly": true, "type": "string" }, "passCount": { "description": "Output only. The number of times the tool passed.", "type": "integer", "format": "int32", "readOnly": true }, "failCount": { "description": "Output only. The number of times the tool failed.", "readOnly": true, "type": "integer", "format": "int32" } }, "type": "object", "description": "Metrics for a single tool." }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "type": "object", "properties": { "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "name": { "type": "string", "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}`." }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any." }, "response": { "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": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" } } }, "Conversation": { "id": "Conversation", "properties": { "turnCount": { "type": "integer", "description": "Output only. The number of turns in the conversation.", "format": "int32", "readOnly": true }, "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}`" }, "source": { "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "description": "Output only. Indicate the source of the conversation.", "readOnly": true, "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "type": "string" }, "channelType": { "enum": [ "CHANNEL_TYPE_UNSPECIFIED", "TEXT", "AUDIO", "MULTIMODAL" ], "deprecated": true, "type": "string", "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." ], "description": "DEPRECATED. Please use input_types instead." }, "endTime": { "description": "Output only. Timestamp when the conversation was completed.", "readOnly": true, "format": "google-datetime", "type": "string" }, "turns": { "description": "Required. The turns in the conversation.", "type": "array", "items": { "$ref": "ConversationTurn" } }, "entryAgent": { "description": "Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string", "readOnly": true }, "messages": { "items": { "$ref": "Message" }, "deprecated": true, "type": "array", "description": "Deprecated. Use turns instead." }, "inputTypes": { "items": { "enumDescriptions": [ "Unspecified input type.", "Text input.", "Event input.", "Audio input.", "Image input.", "Blob input.", "Client function tool response input.", "Variables input." ], "type": "string", "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": "array", "description": "Output only. The input types of the conversation.", "readOnly": true }, "name": { "description": "Identifier. The unique identifier of the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`", "type": "string" }, "languageCode": { "type": "string", "description": "Output only. The language code of the conversation.", "readOnly": true }, "startTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when the conversation was created.", "type": "string" }, "deployment": { "readOnly": true, "description": "Output only. The deployment of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" } }, "description": "A conversation represents an interaction between an end user and the CES app.", "type": "object" }, "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" } }, "id": "ErrorHandlingSettingsEndSessionConfig", "type": "object", "description": "Configuration for ending the session in case of system errors (e.g. LLM errors)." }, "ToolFakeConfig": { "id": "ToolFakeConfig", "description": "Configuration for tool behavior in fake mode.", "type": "object", "properties": { "codeBlock": { "$ref": "CodeBlock", "description": "Optional. Code block which will be executed instead of a real tool call." }, "enableFakeMode": { "description": "Optional. Whether the tool is using fake mode.", "type": "boolean" } } }, "EndpointControlPolicy": { "type": "object", "id": "EndpointControlPolicy", "properties": { "enforcementScope": { "type": "string", "enum": [ "ENFORCEMENT_SCOPE_UNSPECIFIED", "VPCSC_ONLY", "ALWAYS" ], "description": "Optional. The scope in which this policy's allowed_origins list is enforced.", "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." ] }, "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" } }, "description": "Defines project/location level endpoint control policy." }, "AgentSkill": { "properties": { "outputModes": { "type": "array", "items": { "type": "string" }, "description": "The set of supported output media types for this skill, overriding the agent's defaults." }, "id": { "description": "Required. A unique identifier for the agent's skill.", "type": "string" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Required. A set of keywords describing the skill's capabilities." }, "inputModes": { "items": { "type": "string" }, "type": "array", "description": "The set of supported input media types for this skill, overriding the agent's defaults." }, "name": { "description": "Required. A human-readable name for the skill.", "type": "string" }, "examples": { "items": { "type": "string" }, "type": "array", "description": "Example prompts or scenarios that this skill can handle." }, "description": { "description": "Required. A detailed description of the skill.", "type": "string" } }, "id": "AgentSkill", "description": "Represents a distinct capability or function that an agent can perform.", "type": "object" }, "AudioProcessingConfig": { "id": "AudioProcessingConfig", "description": "Configuration for how the input and output audio should be processed and delivered.", "properties": { "synthesizeSpeechConfigs": { "description": "Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains \"en-us\" and \"en\", and the specified language code is \"en-gb\", then \"en\" configuration will be used. Note: Language code is case-insensitive.", "type": "object", "additionalProperties": { "$ref": "SynthesizeSpeechConfig" } }, "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": { "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.", "type": "string", "format": "google-duration" }, "bargeInConfig": { "$ref": "BargeInConfig", "description": "Optional. Configures the agent behavior for the user barge-in activities." }, "customVoiceSamples": { "description": "Optional. Configures custom voice samples for voice cloning.", "items": { "$ref": "CustomVoiceSample" }, "type": "array" } }, "type": "object" }, "EvaluationConfig": { "description": "EvaluationConfig configures settings for running the evaluation.", "properties": { "evaluationChannel": { "enumDescriptions": [ "Unspecified evaluation channel.", "Text-only evaluation channel.", "Audio evaluation channel." ], "description": "Optional. The channel to evaluate.", "type": "string", "enum": [ "EVALUATION_CHANNEL_UNSPECIFIED", "TEXT", "AUDIO" ] }, "toolCallBehaviour": { "description": "Optional. Specifies whether the evaluation should use real tool calls or fake tools.", "enumDescriptions": [ "Unspecified tool call behavior. Will default to real tool calls.", "Use real tool calls.", "Use fake tool calls." ], "type": "string", "enum": [ "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED", "REAL", "FAKE" ] }, "outputAudioConfig": { "description": "Optional. Configuration for generating the output audio.", "$ref": "OutputAudioConfig" }, "inputAudioConfig": { "description": "Optional. Configuration for processing the input audio.", "$ref": "InputAudioConfig" } }, "id": "EvaluationConfig", "type": "object" }, "MockConfig": { "type": "object", "id": "MockConfig", "properties": { "mockedToolCalls": { "description": "Optional. All tool calls to mock for the duration of the session.", "type": "array", "items": { "$ref": "MockedToolCall" } }, "unmatchedToolCallBehavior": { "type": "string", "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." ], "description": "Required. Beavhior for tool calls that don't match any args patterns in mocked_tool_calls." } }, "description": "Mock tool calls configuration for the session." }, "PersonaRunConfig": { "description": "Configuration for running an evaluation for a specific persona.", "type": "object", "id": "PersonaRunConfig", "properties": { "taskCount": { "format": "int32", "description": "Optional. The number of tasks to run for the persona.", "type": "integer" }, "persona": { "type": "string", "description": "Optional. The persona to use for the evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`" } } }, "TurnResumeSnapshot": { "id": "TurnResumeSnapshot", "properties": { "resolvedSequenceNumber": { "format": "int64", "type": "string", "description": "The position this snapshot represents. Live events follow with sequence_number strictly greater than this. When lower than the resume_from_sequence_number the client requested, flushed progress lags what the client already rendered: the client must discard its rendered content of this turn beyond this position before applying the snapshot." }, "orphanDeadlineTime": { "type": "string", "format": "google-datetime", "description": "When the turn will be wound down if no client remains attached." }, "turnId": { "description": "Identifies the turn being attached to.", "type": "string" }, "events": { "type": "array", "description": "Compacted events reconstructing the turn's visible output, in render order, using the same event shapes as live streaming.", "items": { "$ref": "StreamChatAiAssistantResponse" } } }, "type": "object", "description": "A compacted replay of an in-flight turn: everything needed to render the turn's visible output so far, plus the position live events continue from." }, "ListChangelogsResponse": { "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": { "description": "The list of changelogs.", "items": { "$ref": "Changelog" }, "type": "array" } }, "id": "ListChangelogsResponse", "description": "Response message for AgentService.ListChangelogs.", "type": "object" }, "EvaluationPersonaSpeechConfig": { "id": "EvaluationPersonaSpeechConfig", "properties": { "environment": { "description": "Optional. The simulated audio environment.", "enumDescriptions": [ "Background environment unspecified.", "Call center environment.", "Traffic noise environment.", "Kids noise environment.", "Cafe environment." ], "type": "string", "enum": [ "BACKGROUND_ENVIRONMENT_UNSPECIFIED", "CALL_CENTER", "TRAFFIC", "KIDS_NOISE", "CAFE" ] }, "voiceId": { "description": "Optional. The specific voice identifier/accent to use. Example: \"en-US-Wavenet-D\" or \"en-GB-Standard-A\"", "type": "string" }, "speakingRate": { "description": "Optional. The speaking rate. 1.0 is normal. Lower is slower (e.g., 0.8), higher is faster (e.g., 1.5). Useful for testing how the agent handles fast talkers.", "type": "number", "format": "double" } }, "type": "object", "description": "Configuration for Text-to-Speech generation." }, "ToolResponse": { "properties": { "agentName": { "description": "Output only. Human-readable name of the agent that issued this call, e.g. \"Contract Architect\". Empty when the root agent issued it.", "readOnly": true, "type": "string" }, "toolsetTool": { "$ref": "ToolsetTool", "description": "Optional. The toolset tool that got executed." }, "displayName": { "description": "Output only. Display name of the tool.", "readOnly": true, "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "id": { "type": "string", "description": "Optional. The matching ID of the tool call the response is for." }, "parentToolCallId": { "type": "string", "readOnly": true, "description": "Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling." } }, "description": "The execution result of a specific tool from the client or the agent.", "id": "ToolResponse", "type": "object" }, "GenerateAppResourceResponseGenerateResultInfo": { "type": "object", "description": "This provides additional information about the generated result.", "id": "GenerateAppResourceResponseGenerateResultInfo", "properties": { "explanation": { "type": "string", "description": "An explanation of the changes in the generated resource." } } }, "EndUserAuthConfig": { "type": "object", "id": "EndUserAuthConfig", "description": "End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`.", "properties": { "oauth2AuthCodeConfig": { "description": "Oauth 2.0 Authorization Code authentication.", "$ref": "EndUserAuthConfigOauth2AuthCodeConfig" }, "oauth2JwtBearerConfig": { "description": "JWT Profile Oauth 2.0 Authorization Grant authentication.", "$ref": "EndUserAuthConfigOauth2JwtBearerConfig" } } }, "EvaluationResultGoldenResultTurnReplayResult": { "type": "object", "id": "EvaluationResultGoldenResultTurnReplayResult", "properties": { "conversation": { "type": "string", "description": "Output only. The conversation that was generated for this turn.", "readOnly": true }, "expectationOutcome": { "readOnly": true, "description": "Output only. The outcome of each expectation.", "type": "array", "items": { "$ref": "EvaluationResultGoldenExpectationOutcome" } }, "hallucinationResult": { "description": "Output only. The result of the hallucination check.", "readOnly": true, "$ref": "EvaluationResultHallucinationResult" }, "spanLatencies": { "readOnly": true, "description": "Output only. The latency of spans in the turn.", "type": "array", "items": { "$ref": "EvaluationResultSpanLatency" } }, "toolCallLatencies": { "readOnly": true, "type": "array", "items": { "$ref": "EvaluationResultToolCallLatency" }, "description": "Output only. The latency of each tool call in the turn." }, "overallToolInvocationResult": { "readOnly": true, "description": "Output only. The result of the overall tool invocation check.", "$ref": "EvaluationResultOverallToolInvocationResult" }, "semanticSimilarityResult": { "$ref": "EvaluationResultSemanticSimilarityResult", "description": "Output only. The result of the semantic similarity check.", "readOnly": true }, "errorInfo": { "$ref": "EvaluationErrorInfo", "readOnly": true, "description": "Output only. Information about the error that occurred during this turn." }, "toolOrderedInvocationScore": { "readOnly": true, "description": "Output only. The overall tool ordered invocation score for this turn. This indicates the overall percent of tools from the expected turn that were actually invoked in the expected order.", "type": "number", "format": "float" }, "turnLatency": { "format": "google-duration", "readOnly": true, "description": "Output only. Duration of the turn.", "type": "string" }, "toolInvocationScore": { "deprecated": true, "readOnly": true, "description": "Output only. Deprecated. Use OverallToolInvocationResult instead.", "format": "float", "type": "number" } }, "description": "The result of running a single turn of the golden conversation." }, "ImportEvaluationsRequest": { "description": "Request message for EvaluationService.ImportEvaluations.", "properties": { "csvContent": { "format": "byte", "type": "string", "description": "Raw bytes representing the csv file with the evaluations structure." }, "conversationList": { "description": "The conversations to import the evaluations from.", "$ref": "ImportEvaluationsRequestConversationList" }, "importOptions": { "$ref": "ImportEvaluationsRequestImportOptions", "description": "Optional. Options governing the import process for the evaluations." }, "gcsUri": { "type": "string", "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI from which to import evaluations. The format of this URI must be `gs:///`." } }, "type": "object", "id": "ImportEvaluationsRequest" }, "EvaluationErrorInfo": { "description": "Information about an error encountered during an evaluation execution.", "type": "object", "properties": { "errorType": { "type": "string", "description": "Output only. The type of error.", "readOnly": true, "enum": [ "ERROR_TYPE_UNSPECIFIED", "RUNTIME_FAILURE", "CONVERSATION_RETRIEVAL_FAILURE", "METRIC_CALCULATION_FAILURE", "EVALUATION_UPDATE_FAILURE", "QUOTA_EXHAUSTED", "USER_SIMULATION_FAILURE" ], "enumDescriptions": [ "Unspecified error type.", "Failure during runtime execution.", "Failure to retrieve conversation from CES Runtime.", "Failure to calculate a metric / outcome.", "Failure to update the evaluation.", "Ran out of quota.", "Failure during user simulation." ] }, "sessionId": { "type": "string", "description": "Output only. The session ID for the conversation that caused the error.", "readOnly": true }, "errorMessage": { "description": "Output only. The error message.", "readOnly": true, "type": "string" }, "userFacingErrorMessage": { "readOnly": true, "description": "Output only. The user facing error message.", "type": "string" } }, "id": "EvaluationErrorInfo" }, "OptionQuestionsChunk": { "description": "Structured clarification options the assistant asks the user to choose among, transduced server-side out of the model's turn (the option block is stripped from the streamed and persisted text). The console renders a keyboard-navigable option list docked above the composer.", "id": "OptionQuestionsChunk", "type": "object", "properties": { "questions": { "type": "array", "items": { "$ref": "OptionQuestionsChunkQuestion" }, "description": "The questions asked this turn. More than one entry drives the console's \"1 of N\" pager." } } }, "GenerateAppResourceResponse": { "properties": { "tools": { "description": "The list of tools generated by the LLM assistant.", "$ref": "GenerateAppResourceResponseTools" }, "appResources": { "$ref": "GenerateAppResourceResponseAppResources", "description": "The app resources generated by the LLM assistant." }, "generateResultInfo": { "$ref": "GenerateAppResourceResponseGenerateResultInfo", "description": "Additional information about the generated result." }, "toolset": { "description": "Toolset generated by the LLM assistant. Supports Open API toolset schema generation.", "$ref": "Toolset" }, "agent": { "$ref": "Agent", "description": "Agent generated by the LLM assistant." }, "evaluations": { "$ref": "GenerateAppResourceResponseEvaluations", "description": "Evaluations generated by the LLM assistant." }, "qualityReport": { "description": "The quality report generated by the LLM assistant.", "$ref": "QualityReport" }, "appSnapshot": { "$ref": "AppSnapshot", "description": "App snapshot generated by the LLM assistant. This snapshot contains the app, agents & tools generated by the LLM assistant." } }, "type": "object", "description": "Response message for AgentService.GenerateAppResource.", "id": "GenerateAppResourceResponse" }, "Tool": { "type": "object", "properties": { "systemTool": { "$ref": "SystemTool", "description": "Optional. The system tool." }, "fileSearchTool": { "$ref": "FileSearchTool", "description": "Optional. The file search tool." }, "mcpTool": { "$ref": "McpTool", "description": "Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset." }, "widgetTool": { "$ref": "WidgetTool", "description": "Optional. The widget tool." }, "remoteAgentTool": { "description": "Optional. The remote agent tool.", "$ref": "RemoteAgentTool" }, "agentTool": { "$ref": "AgentTool", "description": "Optional. The agent tool." }, "timeout": { "type": "string", "format": "google-duration", "description": "Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools." }, "executionType": { "description": "Optional. The execution type of the tool.", "enumDescriptions": [ "The execution type is unspecified. Defaults to `SYNCHRONOUS` if unspecified.", "The tool is executed synchronously. The session is blocked until the tool returns.", "The tool is executed asynchronously. The session will continue while the tool is executing." ], "type": "string", "enum": [ "EXECUTION_TYPE_UNSPECIFIED", "SYNCHRONOUS", "ASYNCHRONOUS" ] }, "googleSearchTool": { "description": "Optional. The google search tool.", "$ref": "GoogleSearchTool" }, "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" }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the tool was created." }, "pythonFunction": { "$ref": "PythonFunction", "description": "Optional. The python function tool." }, "toolFakeConfig": { "$ref": "ToolFakeConfig", "description": "Optional. Configuration for tool behavior in fake mode." }, "dataStoreTool": { "$ref": "DataStoreTool", "description": "Optional. The data store tool." }, "updateTime": { "readOnly": true, "description": "Output only. Timestamp when the tool was last updated.", "format": "google-datetime", "type": "string" }, "generatedSummary": { "readOnly": true, "description": "Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.", "type": "string" }, "connectorTool": { "description": "Optional. The Integration Connector tool.", "$ref": "ConnectorTool" }, "displayName": { "description": "Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its `name` property.", "type": "string", "readOnly": true }, "openApiTool": { "description": "Optional. The open API tool.", "$ref": "OpenApiTool" }, "name": { "type": "string", "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." }, "clientFunction": { "$ref": "ClientFunction", "description": "Optional. The client function." }, "readOnly": { "description": "Output only. Indicates whether the tool is read-only. If true, the tool cannot be modified by the user.", "readOnly": true, "type": "boolean" } }, "description": "A tool represents an action that the CES agent can take to achieve certain goals.", "id": "Tool" }, "SessionOutputDiagnosticInfo": { "properties": { "messages": { "items": { "$ref": "Message" }, "description": "List of the messages that happened during the processing.", "type": "array" }, "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" } }, "id": "SessionOutputDiagnosticInfo", "type": "object", "description": "Contains execution details during the processing." }, "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec": { "properties": { "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.", "type": "string", "enum": [ "INTERPOLATION_TYPE_UNSPECIFIED", "LINEAR" ] }, "fieldName": { "description": "Optional. The name of the field whose value will be used to determine the boost amount.", "type": "string" }, "attributeType": { "type": "string", "enum": [ "ATTRIBUTE_TYPE_UNSPECIFIED", "NUMERICAL", "FRESHNESS" ], "enumDescriptions": [ "Unspecified AttributeType.", "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. E.g. `5D`, `3DT12H30M`, `T24H`." ], "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)." }, "controlPoints": { "type": "array", "items": { "$ref": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, "description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here." } }, "type": "object", "id": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec", "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above." }, "TriggerActionRespondImmediately": { "properties": { "responses": { "type": "array", "description": "Required. The canned responses for the agent to choose from. The response is chosen randomly.", "items": { "$ref": "TriggerActionResponse" } } }, "type": "object", "description": "The agent will immediately respond with a preconfigured response.", "id": "TriggerActionRespondImmediately" }, "RemoteAgentTool": { "id": "RemoteAgentTool", "type": "object", "description": "Represents a tool that allows the agent to call another remote agent.", "properties": { "inputVariableMapping": { "description": "Optional. Mapping of input variable names of remote agent to GECX variable names.", "additionalProperties": { "type": "string" }, "type": "object" }, "outputVariableMapping": { "description": "Optional. Mapping of output variable names of remote agent to GECX variable names.", "additionalProperties": { "type": "string" }, "type": "object" }, "description": { "description": "Required. The description of the tool.", "type": "string" }, "apiAuthentication": { "description": "Optional. Authentication configuration for calling the remote agent.", "$ref": "ApiAuthentication" }, "agentCard": { "description": "Required. The agent card of the remote agent that this tool invokes.", "$ref": "AgentCard" }, "name": { "type": "string", "description": "Required. The name of the tool." }, "statefulAgent": { "description": "Optional. When enabled, the interaction between the CXAS app and the remote agent will share the same context. If the remote agent returns a context_id, it will be persisted for the entirety of the session for this remote agent tool.", "type": "boolean" } } }, "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", "description": "Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days.", "format": "google-duration" } }, "id": "ConversationLoggingSettings", "type": "object" }, "LfA2aV1AgentInterface": { "properties": { "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" }, "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" }, "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" }, "tenant": { "type": "string", "description": "Optional. An opaque string used for routing requests to a specific agent or tenant when multiple agents are served behind a single A2A endpoint. When set, clients MUST include this value in the `tenant` field of all request messages sent to this interface. The server is responsible for interpreting the value and routing requests accordingly; the protocol does not define its format or semantics." } }, "id": "LfA2aV1AgentInterface", "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.", "type": "object" }, "PythonCodeCondition": { "id": "PythonCodeCondition", "type": "object", "properties": { "pythonCode": { "type": "string", "description": "Required. The python code to execute." } }, "description": "Python code block to evaluate the condition." }, "Callback": { "id": "Callback", "type": "object", "description": "A callback defines the custom logic to be executed at various stages of agent interaction.", "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": { "type": "boolean", "description": "Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent." }, "pythonCode": { "type": "string", "description": "Required. The python code to execute for the callback." }, "description": { "description": "Optional. Human-readable description of the callback.", "type": "string" } } }, "EvaluationDataset": { "id": "EvaluationDataset", "description": "An evaluation dataset represents a set of evaluations that are grouped together basaed on shared tags.", "type": "object", "properties": { "lastUpdatedBy": { "readOnly": true, "type": "string", "description": "Output only. The user who last updated the evaluation dataset." }, "name": { "type": "string", "description": "Identifier. The unique identifier of this evaluation dataset. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`" }, "etag": { "readOnly": true, "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.", "type": "string" }, "evaluations": { "items": { "type": "string" }, "type": "array", "description": "Optional. Evaluations that are included in this dataset." }, "displayName": { "type": "string", "description": "Required. User-defined display name of the evaluation dataset. Unique within an App." }, "createdBy": { "readOnly": true, "type": "string", "description": "Output only. The user who created the evaluation dataset." }, "createTime": { "type": "string", "description": "Output only. Timestamp when the evaluation dataset was created.", "format": "google-datetime", "readOnly": true }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when the evaluation dataset was last updated.", "readOnly": true }, "aggregatedMetrics": { "readOnly": true, "$ref": "AggregatedMetrics", "description": "Output only. The aggregated metrics for this evaluation dataset across all runs." } } }, "EvaluationRunCachingSettings": { "id": "EvaluationRunCachingSettings", "properties": { "runCachingMode": { "type": "string", "enumDescriptions": [ "The run caching mode is unspecified.", "Always execute a full live simulation regardless of whether changelogs exist.", "Skip execution and copy previous verified results if no dependencies have mutated, the evaluation channel/run method are the same." ], "enum": [ "EVALUATION_RUN_CACHING_MODE_UNSPECIFIED", "FORCE_RUN", "SKIP_IF_UNCHANGED" ], "description": "Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN." } }, "type": "object", "description": "Settings for evaluation run caching." }, "ListAppVersionsResponse": { "type": "object", "properties": { "appVersions": { "description": "The list of app versions.", "type": "array", "items": { "$ref": "AppVersion" } }, "nextPageToken": { "type": "string", "description": "A token that can be sent as ListAppVersionsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages." } }, "id": "ListAppVersionsResponse", "description": "Response message for AgentService.ListAppVersions." }, "DeleteEvaluationRunOperationMetadata": { "properties": {}, "type": "object", "description": "Operation metadata for EvaluationService.DeleteEvaluationRun.", "id": "DeleteEvaluationRunOperationMetadata" }, "GenerateAppResourceRequest": { "description": "Request message for AgentService.GenerateAppResource.", "id": "GenerateAppResourceRequest", "properties": { "appVersionContext": { "description": "The app version context specifying the base snapshot and target agent.", "$ref": "GenerateAppResourceRequestAppVersionContext" }, "toolset": { "$ref": "Toolset", "description": "The toolset resource to be used by the LLM assistant, can be empty for generating a new toolset." }, "hillClimbingFixConfig": { "$ref": "GenerateAppResourceRequestHillClimbingFixConfig", "description": "Optional. The configuration to be used for hill climbing fixes." }, "tool": { "description": "The tool resource to be used by the LLM assistant, can be empty for generating a new tool.", "$ref": "Tool" }, "evaluationGenerationConfig": { "description": "Optional. The configuration to be used to generate the evaluations.", "$ref": "GenerateAppResourceRequestEvaluationGenerationConfig" }, "appGenerationConfig": { "description": "Optional. The configuration to be used to generate the agents and tools.", "$ref": "GenerateAppResourceRequestAppGenerationConfig" }, "qualityReportGenerationConfig": { "$ref": "GenerateAppResourceRequestQualityReportGenerationConfig", "description": "Optional. The configuration to be used for quality report generation." }, "evaluationPersonasGenerationConfig": { "description": "Optional. The configuration to be used to generate the evaluation personas.", "$ref": "GenerateAppResourceRequestEvaluationPersonasGenerationConfig" }, "toolGenerationConfig": { "description": "Optional. The configuration to be used to generate the tool.", "$ref": "GenerateAppResourceRequestToolGenerationConfig" }, "agent": { "description": "The agent resource to be used by the LLM assistant, can be empty for generating a new agent.", "$ref": "Agent" }, "refineInstructions": { "items": { "$ref": "GenerateAppResourceRequestRefineInstructions" }, "type": "array", "description": "Optional. List of refine instructions to be used to refine the resource." } }, "type": "object" }, "EvaluationRunProgress": { "properties": { "failedCount": { "readOnly": true, "format": "int32", "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)." }, "errorCount": { "type": "integer", "format": "int32", "readOnly": true, "description": "Output only. Number of evaluation results that failed to execute. (EvaluationResult.execution_state is ERROR)." }, "cancelledCount": { "description": "Output only. Number of evaluation results that were cancelled. (EvaluationResult.execution_state is CANCELLED).", "type": "integer", "readOnly": true, "format": "int32" }, "passedCount": { "format": "int32", "type": "integer", "description": "Output only. Number of completed evaluation results with an outcome of PASS. (EvaluationResult.execution_state is COMPLETED and EvaluationResult.evaluation_status is PASS).", "readOnly": true }, "completedCount": { "format": "int32", "description": "Output only. Number of evaluation results that finished successfully. (EvaluationResult.execution_state is COMPLETED).", "type": "integer", "readOnly": true }, "totalCount": { "description": "Output only. Total number of evaluation results in this run.", "readOnly": true, "type": "integer", "format": "int32" } }, "description": "The progress of the evaluation run.", "type": "object", "id": "EvaluationRunProgress" }, "LfA2aV1Task": { "description": "`Task` is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.", "type": "object", "id": "LfA2aV1Task", "properties": { "id": { "type": "string", "description": "Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task." }, "contextId": { "description": "Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages).", "type": "string" }, "artifacts": { "description": "A set of output artifacts for a `Task`.", "type": "array", "items": { "$ref": "LfA2aV1Artifact" } }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task." }, "status": { "$ref": "LfA2aV1TaskStatus", "description": "Required. The current status of a `Task`, including `state` and a `message`." }, "history": { "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`.", "type": "array", "items": { "$ref": "LfA2aV1Message" } } } }, "ClientCertificateSettings": { "id": "ClientCertificateSettings", "type": "object", "description": "Settings for custom client certificates.", "properties": { "privateKey": { "description": "Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`", "type": "string" }, "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" }, "tlsCertificate": { "description": "Required. The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.", "type": "string" } } }, "GenerateAppResourceRequestHillClimbingFixConfig": { "id": "GenerateAppResourceRequestHillClimbingFixConfig", "type": "object", "description": "The configuration to be used for hill climbing fixes.", "properties": { "qualityReport": { "$ref": "QualityReport", "description": "Required. The quality report used to inform the instruction following fix." } } }, "TransferRule": { "description": "Rule for transferring to a specific agent.", "id": "TransferRule", "properties": { "direction": { "description": "Required. The direction of the transfer.", "type": "string", "enum": [ "DIRECTION_UNSPECIFIED", "PARENT_TO_CHILD", "CHILD_TO_PARENT" ], "enumDescriptions": [ "Unspecified direction.", "Transfer from the parent agent to the child agent.", "Transfer from the child agent to the parent agent." ] }, "deterministicTransfer": { "$ref": "TransferRuleDeterministicTransfer", "description": "Optional. A rule that immediately transfers to the target agent when the condition is met." }, "disablePlannerTransfer": { "$ref": "TransferRuleDisablePlannerTransfer", "description": "Optional. Rule that prevents the planner from transferring to the target agent." }, "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" } }, "type": "object" }, "GenerateAppResourceResponseTools": { "id": "GenerateAppResourceResponseTools", "properties": { "tools": { "description": "The list of tools generated by the LLM assistant.", "items": { "$ref": "Tool" }, "type": "array" } }, "description": "The list of tools generated by the LLM assistant.", "type": "object" }, "GoogleSearchTool": { "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": { "preferredDomains": { "type": "array", "description": "Optional. Specifies domains to restrict search results to. Example: \"example.com\", \"another.site\". A maximum of 20 domains can be specified.", "items": { "type": "string" } }, "contextUrls": { "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.", "items": { "type": "string" } }, "description": { "description": "Optional. Description of the tool's purpose.", "type": "string" }, "name": { "description": "Required. The name of the tool.", "type": "string" }, "excludeDomains": { "items": { "type": "string" }, "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" }, "promptConfig": { "$ref": "GoogleSearchToolPromptConfig", "description": "Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice." } }, "type": "object" }, "EvaluationScenarioExpectation": { "id": "EvaluationScenarioExpectation", "description": "The expectation to evaluate the conversation produced by the simulation.", "type": "object", "properties": { "agentResponse": { "$ref": "Message", "description": "Optional. The agent response to be evaluated." }, "toolExpectation": { "description": "Optional. The tool call and response pair to be evaluated.", "$ref": "EvaluationScenarioExpectationToolExpectation" } } }, "TriggerActionTransferAgent": { "properties": { "agent": { "type": "string", "description": "Required. The name of the agent to transfer the conversation to. The agent must be in the same app as the current agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`" } }, "description": "The agent will transfer the conversation to a different agent.", "type": "object", "id": "TriggerActionTransferAgent" }, "EvaluationPersona": { "type": "object", "properties": { "speechConfig": { "description": "Optional. Configuration for how the persona sounds (TTS settings).", "$ref": "EvaluationPersonaSpeechConfig" }, "name": { "description": "Required. The unique identifier of the persona. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`", "type": "string" }, "personality": { "type": "string", "description": "Required. An instruction for the agent on how to behave in the evaluation." }, "description": { "description": "Optional. The description of the persona.", "type": "string" }, "displayName": { "type": "string", "description": "Required. The display name of the persona. Unique within an app." } }, "id": "EvaluationPersona", "description": "A persona represents an end user in an evaluation." }, "TransferRuleDisablePlannerTransfer": { "type": "object", "id": "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." }, "Status": { "type": "object", "id": "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" }, "details": { "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." } }, "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)." }, "GuardrailLlmPromptSecurity": { "description": "Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification.", "id": "GuardrailLlmPromptSecurity", "type": "object", "properties": { "customPolicy": { "description": "Optional. Use a user-defined LlmPolicy to configure the security guardrail.", "$ref": "GuardrailLlmPolicy" }, "defaultSettings": { "$ref": "GuardrailLlmPromptSecurityDefaultSecuritySettings", "description": "Optional. Use the system's predefined default security settings. To select this mode, include an empty 'default_settings' message in the request. The 'default_prompt_template' field within will be populated by the server in the response." }, "failOpen": { "type": "boolean", "description": "Optional. Determines the behavior when the guardrail encounters an LLM error. - If true: the guardrail is bypassed. - If false (default): the guardrail triggers/blocks. Note: If a custom policy is provided, this field is ignored in favor of the policy's 'fail_open' configuration." } } }, "ApiKeyConfig": { "description": "Configurations for authentication with API key.", "id": "ApiKeyConfig", "properties": { "requestLocation": { "enumDescriptions": [ "Unspecified. This value should not be used.", "Represents the key in http header.", "Represents the key in query string." ], "type": "string", "enum": [ "REQUEST_LOCATION_UNSPECIFIED", "HEADER", "QUERY_STRING" ], "description": "Required. Key location in the request." }, "apiKeySecretVersion": { "type": "string", "description": "Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`." }, "keyName": { "type": "string", "description": "Required. The parameter name or the header name of the API key. E.g., If the API request is \"https://example.com/act?X-Api-Key=\", \"X-Api-Key\" would be the parameter name." } }, "type": "object" }, "ExportEvaluationResultsResponse": { "type": "object", "id": "ExportEvaluationResultsResponse", "properties": { "evaluationResultsUri": { "type": "string", "description": "The Google Cloud Storage URI folder where the exported Evaluation Results were written. This will be populated if gcs_uri was specified in the request." }, "evaluationResultsContent": { "type": "string", "description": "The content of the exported Evaluation Results. This will be populated if gcs_uri was not specified in the request.", "format": "byte" } }, "description": "Response message for EvaluationService.ExportEvaluationResults." }, "GenerateAppResourceResponseAppResources": { "type": "object", "description": "The list of app resources generated by the LLM assistant.", "properties": { "evaluations": { "items": { "$ref": "Evaluation" }, "description": "The list of evaluations generated by the LLM assistant.", "type": "array" }, "appSnapshot": { "$ref": "AppSnapshot", "description": "The app snapshot generated by the LLM assistant. This snapshot contains the app, agents & tools generated by the LLM assistant." } }, "id": "GenerateAppResourceResponseAppResources" }, "LfA2aV1HTTPAuthSecurityScheme": { "type": "object", "description": "Defines a security scheme using HTTP authentication.", "id": "LfA2aV1HTTPAuthSecurityScheme", "properties": { "description": { "description": "An optional description for the security scheme.", "type": "string" }, "bearerFormat": { "description": "A hint to the client to identify how the bearer token is formatted (e.g., \"JWT\"). Primarily for documentation purposes.", "type": "string" }, "scheme": { "type": "string", "description": "Required. The name of the HTTP Authentication scheme to be used in the Authorization header, as defined in RFC7235 (e.g., \"Bearer\"). This value should be registered in the IANA Authentication Scheme registry." } } }, "CreateAssistantSessionRequest": { "type": "object", "properties": { "assistantSessionMessages": { "type": "array", "items": { "$ref": "AssistantMessage" }, "description": "Optional. The messages to seed the assistant session with." }, "assistantSessionId": { "type": "string", "description": "Optional. The ID to use for the assistant session, which will become the final component of the assistant session's resource name. If not provided, a unique ID will be automatically assigned for the assistant session." } }, "id": "CreateAssistantSessionRequest", "description": "Request message for AssistantService.CreateAssistantSession." }, "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig": { "description": "The configuration to be used to generate an Open API schema.", "type": "object", "id": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig", "properties": { "operationGenerationConfigs": { "items": { "$ref": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig" }, "description": "Required. The list of operations to be added to the Open API schema.", "type": "array" }, "uri": { "type": "string", "description": "Required. The base uri of the tool." } } }, "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig": { "description": "The configuration to be used to generate an operation in the Open API schema.", "properties": { "responseJson": { "description": "Required. A sample response from the tool in JSON format.", "type": "string" }, "path": { "description": "Required. The path of the tool to be appended to the base uri. This should include query and path parameters if any.", "type": "string" }, "requestJson": { "type": "string", "description": "Required. A sample request to the tool in JSON format. Skip if the tool does not support request body." }, "method": { "description": "Required. The uri of the tool. This should include query and path parameters if any.", "type": "string" } }, "id": "GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig", "type": "object" }, "LfA2aV1AgentCard": { "properties": { "name": { "description": "Required. A human readable name for the agent. Example: \"Recipe Agent\"", "type": "string" }, "iconUrl": { "description": "Optional. A URL to an icon for the agent.", "type": "string" }, "securityRequirements": { "type": "array", "items": { "$ref": "LfA2aV1SecurityRequirement" }, "description": "Security requirements for contacting the agent." }, "documentationUrl": { "description": "A URL providing additional documentation about the agent.", "type": "string" }, "signatures": { "description": "JSON Web Signatures computed for this `AgentCard`.", "type": "array", "items": { "$ref": "LfA2aV1AgentCardSignature" } }, "version": { "description": "Required. The version of the agent. Example: \"1.0.0\"", "type": "string" }, "defaultOutputModes": { "items": { "type": "string" }, "type": "array", "description": "Required. The media types supported as outputs from this agent." }, "skills": { "description": "Required. Skills represent the abilities of an agent. It is largely a descriptive concept but represents a more focused set of behaviors that the agent is likely to succeed at.", "type": "array", "items": { "$ref": "LfA2aV1AgentSkill" } }, "defaultInputModes": { "items": { "type": "string" }, "type": "array", "description": "Required. protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as media types." }, "capabilities": { "description": "Required. A2A Capability set supported by the agent.", "$ref": "LfA2aV1AgentCapabilities" }, "supportedInterfaces": { "type": "array", "items": { "$ref": "LfA2aV1AgentInterface" }, "description": "Required. Ordered list of supported interfaces. The first entry is preferred." }, "securitySchemes": { "type": "object", "additionalProperties": { "$ref": "LfA2aV1SecurityScheme" }, "description": "The security scheme details used for authenticating with this agent." }, "provider": { "$ref": "LfA2aV1AgentProvider", "description": "The service provider of the agent." }, "description": { "description": "Required. A human-readable description of the agent, assisting users and other agents in understanding its purpose. Example: \"Agent that helps users with recipes and cooking.\"", "type": "string" } }, "id": "LfA2aV1AgentCard", "description": "A self-describing manifest for an agent. It provides essential metadata including the agent's identity, capabilities, skills, supported communication methods, and security requirements. Next ID: 20", "type": "object" }, "LfA2aV1AgentSkill": { "properties": { "tags": { "type": "array", "items": { "type": "string" }, "description": "Required. A set of keywords describing the skill's capabilities." }, "securityRequirements": { "description": "Security schemes necessary for this skill.", "type": "array", "items": { "$ref": "LfA2aV1SecurityRequirement" } }, "outputModes": { "type": "array", "items": { "type": "string" }, "description": "The set of supported output media types for this skill, overriding the agent's defaults." }, "id": { "type": "string", "description": "Required. A unique identifier for the agent's skill." }, "name": { "description": "Required. A human-readable name for the skill.", "type": "string" }, "description": { "description": "Required. A detailed description of the skill.", "type": "string" }, "examples": { "type": "array", "items": { "type": "string" }, "description": "Example prompts or scenarios that this skill can handle." }, "inputModes": { "description": "The set of supported input media types for this skill, overriding the agent's defaults.", "type": "array", "items": { "type": "string" } } }, "id": "LfA2aV1AgentSkill", "description": "Represents a distinct capability or function that an agent can perform.", "type": "object" }, "ImportEvaluationsOperationMetadata": { "type": "object", "id": "ImportEvaluationsOperationMetadata", "properties": { "statusMessage": { "type": "string", "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "description": "Represents the metadata of the long-running operation for EvaluationService.ImportEvaluations." }, "GuardrailLlmPromptSecurityDefaultSecuritySettings": { "description": "Configuration for default system security settings.", "properties": { "defaultPromptTemplate": { "readOnly": true, "type": "string", "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." } }, "id": "GuardrailLlmPromptSecurityDefaultSecuritySettings", "type": "object" }, "LfA2aV1OpenIdConnectSecurityScheme": { "type": "object", "id": "LfA2aV1OpenIdConnectSecurityScheme", "properties": { "openIdConnectUrl": { "type": "string", "description": "Required. The [OpenID Connect Discovery URL](https://openid.net/specs/openid-connect-discovery-1_0.html) for the OIDC provider's metadata." }, "description": { "description": "An optional description for the security scheme.", "type": "string" } }, "description": "Defines a security scheme using OpenID Connect." }, "DataStoreToolBoostSpecs": { "id": "DataStoreToolBoostSpecs", "type": "object", "properties": { "dataStores": { "items": { "type": "string" }, "type": "array", "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}." }, "spec": { "type": "array", "description": "Required. A list of boosting specifications.", "items": { "$ref": "DataStoreToolBoostSpec" } } }, "description": "Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting." }, "RunEvaluationResultMetricsRequest": { "id": "RunEvaluationResultMetricsRequest", "description": "Request message for EvaluationService.RunEvaluationResultMetrics.", "properties": {}, "type": "object" }, "InputAudioConfig": { "id": "InputAudioConfig", "description": "InputAudioConfig configures how the CES agent should interpret the incoming audio data.", "type": "object", "properties": { "sampleRateHertz": { "format": "int32", "type": "integer", "description": "Required. The sample rate (in Hertz) of the input audio data." }, "noiseSuppressionLevel": { "type": "string", "description": "Optional. Whether to enable noise suppression on the input audio. Available values are \"low\", \"moderate\", \"high\", \"very_high\"." }, "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.", "type": "string", "enum": [ "AUDIO_ENCODING_UNSPECIFIED", "LINEAR16", "MULAW", "ALAW" ] } } }, "RetrieveToolsResponse": { "properties": { "tools": { "description": "The list of tools that are included in the specified toolset.", "type": "array", "items": { "$ref": "Tool" } } }, "id": "RetrieveToolsResponse", "description": "Response message for ToolService.RetrieveTools.", "type": "object" }, "GenerateOnboardingSuggestionsRequest": { "type": "object", "id": "GenerateOnboardingSuggestionsRequest", "properties": { "maxSuggestions": { "type": "integer", "format": "int32", "description": "Optional. Maximum number of suggestions to return. Defaults to 4 when unset." } }, "description": "Request message for SessionService.GenerateOnboardingSuggestions." }, "GenerateAppResourceRequestAppGenerationConfig": { "type": "object", "properties": { "fileContexts": { "description": "Optional. The files to be used as context.", "items": { "$ref": "FileContext" }, "type": "array" }, "context": { "type": "string", "description": "Optional. The context which describes the requirements of the agents & tools to be generated." }, "datasetId": { "type": "string", "description": "Optional. The insights dataset to be used to fetch conversation data for generating the agents & tools. Format: `projects/{project}/locations/{location}/datasets/{dataset}`." }, "gcsLocation": { "type": "string", "description": "Optional. The Cloud Storage location to store the generated question answer data to be used by the Datastore tool. This data is generated only when using conversation data as an input source. The location must be in the same project as the app. Format: `gs://...`." }, "generateEvaluations": { "type": "boolean", "description": "Optional. Whether to generate the evaluations for the app. If true, the provided context will be used to generate the evaluations data." } }, "description": "The configuration to be used to generate the app.", "id": "GenerateAppResourceRequestAppGenerationConfig" }, "ListEvaluationRunsResponse": { "id": "ListEvaluationRunsResponse", "properties": { "nextPageToken": { "type": "string", "description": "A token that can be sent as ListEvaluationRunsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages." }, "evaluationRuns": { "type": "array", "items": { "$ref": "EvaluationRun" }, "description": "The list of evaluation runs." } }, "description": "Response message for EvaluationService.ListEvaluationRuns.", "type": "object" }, "GuardrailModelSafety": { "description": "Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe.", "properties": { "safetySettings": { "type": "array", "items": { "$ref": "GuardrailModelSafetySafetySetting" }, "description": "Required. List of safety settings." } }, "id": "GuardrailModelSafety", "type": "object" }, "Guardrail": { "properties": { "name": { "description": "Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "type": "string" }, "createTime": { "description": "Output only. Timestamp when the guardrail was created.", "readOnly": true, "format": "google-datetime", "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" }, "contentFilter": { "description": "Optional. Guardrail that bans certain content from being used in the conversation.", "$ref": "GuardrailContentFilter" }, "codeCallback": { "description": "Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution.", "$ref": "GuardrailCodeCallback" }, "enabled": { "type": "boolean", "description": "Optional. Whether the guardrail is enabled." }, "displayName": { "description": "Required. Display name of the guardrail.", "type": "string" }, "supervisor": { "$ref": "GuardrailSupervisor", "description": "Optional. Guardrail that runs supervisor intervention." }, "action": { "description": "Optional. Action to take when the guardrail is triggered.", "$ref": "TriggerAction" }, "etag": { "description": "Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.", "type": "string" }, "llmPolicy": { "$ref": "GuardrailLlmPolicy", "description": "Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification." }, "description": { "type": "string", "description": "Optional. Description of the guardrail." }, "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when the guardrail was last updated." } }, "description": "Guardrail contains a list of checks and balances to keep the agents safe and secure.", "type": "object", "id": "Guardrail" }, "ExecuteToolRequest": { "type": "object", "id": "ExecuteToolRequest", "description": "Request message for ToolService.ExecuteTool.", "properties": { "variables": { "description": "Optional. The variables that are available for the tool execution.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "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" }, "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" }, "context": { "additionalProperties": { "type": "any", "description": "Properties of the 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.", "type": "object" }, "args": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. The input parameters and values for the tool in JSON object format." }, "tool": { "description": "Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}", "type": "string" } } }, "BigQueryExportSettings": { "id": "BigQueryExportSettings", "properties": { "enabled": { "description": "Optional. Indicates whether the BigQuery export is enabled.", "type": "boolean" }, "project": { "type": "string", "description": "Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`." }, "dataset": { "description": "Optional. The BigQuery **dataset ID** to export the data to.", "type": "string" } }, "description": "Settings to describe the BigQuery export behaviors for the app.", "type": "object" }, "ImportAppRequestImportOptions": { "properties": { "validateOnly": { "type": "boolean", "description": "Optional. Flag for dry-running the import process. If set to true, the import process will only perform validations and will not make any changes to the existing app or create a new one." }, "conflictResolutionStrategy": { "description": "Optional. The strategy to use when resolving conflicts during import.", "enumDescriptions": [ "The conflict resolution strategy is unspecified.", "Replace existing data with imported data. If an app with the same `app_id` already exists, its content will be updated based on the imported app. - Resources (App, Agents, Tools, Examples, Guardrails, Toolsets) in the imported app that have the same display name as existing resources will overwrite the existing ones. - Imported resources with new display names will be created. - Existing resources that do not have a matching display name in the imported app will remain untouched.", "Overwrite existing data with imported data. If an app with the same `app_id` already exists, its content will be overwritten with the imported app. - Existing resources (Agents, Tools, Examples, Guardrails, Toolsets) in the app will be deleted. - Imported resources will be created as new resources." ], "type": "string", "enum": [ "CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED", "REPLACE", "OVERWRITE" ] } }, "description": "Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data.", "type": "object", "id": "ImportAppRequestImportOptions" }, "TriggerActionResponse": { "description": "Represents a response from the agent.", "id": "TriggerActionResponse", "type": "object", "properties": { "disabled": { "description": "Optional. Whether the response is disabled. Disabled responses are not used by the agent.", "type": "boolean" }, "text": { "type": "string", "description": "Required. Text for the agent to respond with." } } }, "LatencyReportToolLatency": { "type": "object", "id": "LatencyReportToolLatency", "description": "Latency metrics for a single tool.", "properties": { "tool": { "description": "Output only. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.", "type": "string", "readOnly": true }, "toolsetTool": { "readOnly": true, "description": "Output only. The toolset tool identifier.", "$ref": "ToolsetTool" }, "toolDisplayName": { "description": "Output only. The display name of the tool.", "type": "string", "readOnly": true }, "latencyMetrics": { "description": "Output only. The latency metrics for the tool.", "readOnly": true, "$ref": "LatencyReportLatencyMetrics" } } }, "OutputAudioConfig": { "properties": { "sampleRateHertz": { "description": "Required. The sample rate (in Hertz) of the output audio data.", "type": "integer", "format": "int32" }, "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." ], "type": "string", "enum": [ "AUDIO_ENCODING_UNSPECIFIED", "LINEAR16", "MULAW", "ALAW" ], "description": "Required. The encoding of the output audio data." } }, "description": "OutputAudioConfig configures how the CES agent should synthesize outgoing audio responses.", "type": "object", "id": "OutputAudioConfig" }, "EvaluationResultSpanLatency": { "properties": { "model": { "readOnly": true, "type": "string", "description": "Output only. The name of the LLM span." }, "executionLatency": { "description": "Output only. The latency of span.", "format": "google-duration", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The end time of span." }, "displayName": { "readOnly": true, "type": "string", "description": "Output only. The display name of the span. Applicable to tool and guardrail spans." }, "startTime": { "format": "google-datetime", "description": "Output only. The start time of span.", "readOnly": true, "type": "string" }, "resource": { "readOnly": true, "description": "Output only. The resource name of the guardrail or tool spans.", "type": "string" }, "toolset": { "description": "Output only. The toolset tool identifier.", "$ref": "ToolsetTool", "readOnly": true }, "callback": { "description": "Output only. The name of the user callback span.", "type": "string", "readOnly": true }, "type": { "enum": [ "TYPE_UNSPECIFIED", "TOOL", "USER_CALLBACK", "GUARDRAIL", "LLM" ], "readOnly": true, "enumDescriptions": [ "Default value. This value is unused.", "Tool call span.", "User callback span.", "Guardrail span.", "LLM span." ], "description": "Output only. The type of span.", "type": "string" } }, "type": "object", "id": "EvaluationResultSpanLatency", "description": "The latency of a span execution." }, "EvaluationResultGoldenExpectationOutcome": { "properties": { "outcome": { "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "readOnly": true, "description": "Output only. The outcome of the expectation.", "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." ], "type": "string" }, "observedAgentResponse": { "readOnly": true, "$ref": "Message", "description": "Output only. The result of the agent response expectation." }, "observedToolResponse": { "readOnly": true, "$ref": "ToolResponse", "description": "Output only. The result of the tool response expectation." }, "semanticSimilarityResult": { "$ref": "EvaluationResultSemanticSimilarityResult", "description": "Output only. The result of the semantic similarity check.", "readOnly": true, "deprecated": true }, "observedAgentTransfer": { "readOnly": true, "$ref": "AgentTransfer", "description": "Output only. The result of the agent transfer expectation." }, "observedToolCall": { "$ref": "ToolCall", "description": "Output only. The result of the tool call expectation.", "readOnly": true }, "observedPayload": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "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.", "readOnly": true }, "expectation": { "$ref": "EvaluationGoldenExpectation", "description": "Output only. The expectation that was evaluated.", "readOnly": true }, "toolInvocationResult": { "readOnly": true, "description": "Output only. The result of the tool invocation check.", "$ref": "EvaluationResultGoldenExpectationOutcomeToolInvocationResult" } }, "id": "EvaluationResultGoldenExpectationOutcome", "type": "object", "description": "Specifies the expectation and the result of that expectation." }, "GenerateOnboardingSuggestionsResponse": { "id": "GenerateOnboardingSuggestionsResponse", "properties": { "contextToken": { "type": "string", "description": "Opaque token capturing the onboarding snapshot used to generate these suggestions. Clients echo it on the first StreamChatAiAssistantRequest so the server can reuse the snapshot." }, "userProfile": { "enumDescriptions": [ "Unspecified profile.", "No assistant sessions containing messages.", "One or two assistant sessions containing messages.", "More than two assistant sessions containing messages." ], "description": "Classification of the requesting user's history.", "type": "string", "enum": [ "USER_PROFILE_UNSPECIFIED", "NEW", "EXPLORING", "RETURNING" ] }, "suggestions": { "items": { "$ref": "AssistantSuggestion" }, "type": "array", "description": "Personalized suggestions, ranked most relevant first." } }, "description": "Response message for SessionService.GenerateOnboardingSuggestions.", "type": "object" }, "SecuritySettings": { "id": "SecuritySettings", "description": "Project/Location level security settings for CES.", "properties": { "endpointControlPolicy": { "description": "Optional. Endpoint control related settings.", "$ref": "EndpointControlPolicy" }, "updateTime": { "description": "Output only. Last update time of the security settings.", "readOnly": true, "format": "google-datetime", "type": "string" }, "name": { "type": "string", "description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`" }, "etag": { "description": "Output only. Etag of the security settings.", "readOnly": true, "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. Create time of the security settings.", "type": "string", "format": "google-datetime" } }, "type": "object" }, "UiEvent": { "type": "object", "properties": { "mimeType": { "description": "The media type (MIME type) indicating the format of the UI event payload (e.g., \"application/json+a2ui\").", "type": "string" }, "jsonPayload": { "description": "The JSON payload representing the A2UI surface.", "type": "string" } }, "id": "UiEvent", "description": "Represents a UI event payload." }, "AgentAgentToolset": { "id": "AgentAgentToolset", "description": "A toolset with a selection of its tools.", "type": "object", "properties": { "toolset": { "type": "string", "description": "Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`" }, "toolIds": { "items": { "type": "string" }, "type": "array", "description": "Optional. The tools IDs to filter the toolset." } } }, "DataStoreToolDataStoreSource": { "description": "Configuration for searching within a specific DataStore.", "properties": { "dataStore": { "description": "Optional. The data store.", "$ref": "DataStore" }, "filter": { "type": "string", "description": "Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata" } }, "id": "DataStoreToolDataStoreSource", "type": "object" }, "EndSession": { "description": "Indicates the session has terminated, due to either successful completion (e.g. user says \"Good bye!\" ) or an agent escalation. The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent.", "id": "EndSession", "type": "object", "properties": { "metadata": { "description": "Optional. Provides additional information about the end session signal, such as the reason for ending the session.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } } }, "CodeBlock": { "description": "A code block to be executed instead of a real tool call.", "properties": { "pythonCode": { "type": "string", "description": "Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -\u003e Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -\u003e Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead." } }, "type": "object", "id": "CodeBlock" }, "ToolsetTool": { "id": "ToolsetTool", "type": "object", "properties": { "toolId": { "description": "Optional. The tool ID to filter the tools to retrieve the schema for.", "type": "string" }, "toolset": { "type": "string", "description": "Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`" } }, "description": "A tool that is created from a toolset." }, "LfA2aV1TaskStatus": { "description": "A container for the status of a task", "properties": { "timestamp": { "description": "ISO 8601 Timestamp when the status was recorded. Example: \"2023-10-27T10:00:00Z\"", "type": "string", "format": "google-datetime" }, "state": { "description": "Required. The current state of this task.", "enumDescriptions": [ "The task is in an unknown or indeterminate state.", "Indicates that a task has been successfully submitted and acknowledged.", "Indicates that a task is actively being processed by the agent.", "Indicates that a task has finished successfully. This is a terminal state.", "Indicates that a task has finished with an error. This is a terminal state.", "Indicates that a task was canceled before completion. This is a terminal state.", "Indicates that the agent requires additional user input to proceed. This is an interrupted state.", "Indicates that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", "Indicates that authentication is required to proceed. This is an interrupted state." ], "type": "string", "enum": [ "TASK_STATE_UNSPECIFIED", "TASK_STATE_SUBMITTED", "TASK_STATE_WORKING", "TASK_STATE_COMPLETED", "TASK_STATE_FAILED", "TASK_STATE_CANCELED", "TASK_STATE_INPUT_REQUIRED", "TASK_STATE_REJECTED", "TASK_STATE_AUTH_REQUIRED" ] }, "message": { "$ref": "LfA2aV1Message", "description": "A message associated with the status." } }, "type": "object", "id": "LfA2aV1TaskStatus" }, "EvaluationResultScenarioRubricOutcome": { "type": "object", "properties": { "score": { "readOnly": true, "format": "float", "type": "number", "description": "Output only. The score of the conversation against the rubric." }, "scoreExplanation": { "readOnly": true, "description": "Output only. The rater's response to the rubric.", "type": "string" }, "rubric": { "readOnly": true, "type": "string", "description": "Output only. The rubric that was used to evaluate the conversation." } }, "description": "The outcome of the evaluation against the rubric.", "id": "EvaluationResultScenarioRubricOutcome" }, "ChannelProfile": { "type": "object", "description": "A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony.", "id": "ChannelProfile", "properties": { "disableDtmf": { "description": "Optional. Whether to disable DTMF (dual-tone multi-frequency).", "type": "boolean" }, "whatsappConfig": { "description": "Optional. Configuration specific to WhatsApp deployments.", "$ref": "ChannelProfileWhatsAppConfig" }, "profileId": { "description": "Optional. The unique identifier of the channel profile.", "type": "string" }, "noiseSuppressionLevel": { "type": "string", "description": "Optional. The noise suppression level of the channel profile. Available values are \"low\", \"moderate\", \"high\", \"very_high\"." }, "disableBargeInControl": { "type": "boolean", "description": "Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt." }, "webWidgetConfig": { "description": "Optional. The configuration for the web widget.", "$ref": "ChannelProfileWebWidgetConfig" }, "channelType": { "description": "Optional. The type of the channel profile.", "type": "string", "enum": [ "UNKNOWN", "WEB_UI", "API", "TWILIO", "GOOGLE_TELEPHONY_PLATFORM", "CONTACT_CENTER_AS_A_SERVICE", "CONTACT_CENTER_AS_A_SERVICE_CHAT", "FIVE9", "CONTACT_CENTER_INTEGRATION", "WHATSAPP", "INSTAGRAM" ], "enumDescriptions": [ "Unknown channel type.", "Web UI channel.", "API channel.", "Twilio channel.", "Google Telephony Platform channel.", "Contact Center as a Service (CCaaS) channel.", "Contact Center as a Service (CCaaS Chat) channel.", "Five9 channel.", "Third party contact center integration channel.", "WhatsApp channel.", "Instagram channel." ] }, "instagramConfig": { "$ref": "ChannelProfileInstagramConfig", "description": "Optional. Configuration specific to Instagram deployments." }, "personaProperty": { "description": "Optional. The persona property of the channel profile.", "$ref": "ChannelProfilePersonaProperty" } } }, "AssistantSession": { "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the assistant session was last updated.", "readOnly": true }, "requestor": { "readOnly": true, "description": "Output only. The user who initiated the session.", "type": "string" }, "sessionCheckpoint": { "description": "Output only. Session checkpoint containing user intent and rolling history summary.", "$ref": "SessionCheckpoint", "readOnly": true }, "artifacts": { "readOnly": true, "description": "Output only. Document artifacts (e.g. generated TDDs in markdown) produced by the assistant in this session. Pointers only; the file content lives in the customer's Cloud Storage bucket.", "type": "array", "items": { "$ref": "AssistantSessionArtifact" } }, "createTime": { "description": "Output only. The time the assistant session was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "name": { "description": "Required. Identifier. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{session}`", "type": "string" }, "activeTurn": { "description": "Output only. Attachment info for this session's currently running turn. Unset when no turn is running.", "readOnly": true, "$ref": "ActiveTurnInfo" }, "state": { "enum": [ "ASSISTANT_SESSION_STATE_UNSPECIFIED", "PROCESSING", "IDLE", "PENDING_REVIEW" ], "enumDescriptions": [ "The default value. This value is used if the status is not specified.", "The assistant agent is processing the request as a long running task.", "The assistant agent is idle and does not have any pending requests or response.", "The assistant agent is done processing a long running task and has a response ready for the user." ], "readOnly": true, "type": "string", "description": "Output only. The status of the assistant session." }, "displayName": { "description": "Optional. The display name of the assistant session.", "type": "string" }, "userResponseSuggestions": { "$ref": "UserResponseSuggestions", "readOnly": true, "description": "Output only. Suggested user responses from the assistant agent." }, "messages": { "type": "array", "items": { "$ref": "AssistantMessage" }, "description": "Optional. History of messages in the session." } }, "description": "An assistant session represents a conversation between a user and the assistant agent.", "id": "AssistantSession", "type": "object" }, "DeployChannelResponse": { "type": "object", "properties": { "deployment": { "description": "The created deployment.", "$ref": "Deployment" } }, "id": "DeployChannelResponse", "description": "Response message for AgentService.DeployChannel." }, "LfA2aV1StringList": { "properties": { "list": { "description": "The individual string values.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.", "id": "LfA2aV1StringList" }, "LatencyReport": { "properties": { "sessionCount": { "format": "int32", "readOnly": true, "type": "integer", "description": "Output only. The total number of sessions considered in the latency report." }, "llmCallLatencies": { "items": { "$ref": "LatencyReportLlmCallLatency" }, "type": "array", "readOnly": true, "description": "Output only. Unordered list. Latency metrics for each LLM call." }, "guardrailLatencies": { "type": "array", "items": { "$ref": "LatencyReportGuardrailLatency" }, "description": "Output only. Unordered list. Latency metrics for each guardrail.", "readOnly": true }, "callbackLatencies": { "description": "Output only. Unordered list. Latency metrics for each callback.", "items": { "$ref": "LatencyReportCallbackLatency" }, "type": "array", "readOnly": true }, "toolLatencies": { "items": { "$ref": "LatencyReportToolLatency" }, "readOnly": true, "description": "Output only. Unordered list. Latency metrics for each tool.", "type": "array" } }, "type": "object", "description": "Latency report for the evaluation run.", "id": "LatencyReport" }, "LfA2aV1TaskStatusUpdateEvent": { "description": "An event sent by the agent to notify the client of a change in a task's status.", "id": "LfA2aV1TaskStatusUpdateEvent", "properties": { "metadata": { "description": "Optional. Metadata associated with the task update.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "status": { "$ref": "LfA2aV1TaskStatus", "description": "Required. The new status of the task." }, "contextId": { "description": "Required. The ID of the context that the task belongs to.", "type": "string" }, "taskId": { "type": "string", "description": "Required. The ID of the task that has changed." } }, "type": "object" }, "Citations": { "id": "Citations", "properties": { "citedChunks": { "description": "List of cited pieces of information.", "type": "array", "items": { "$ref": "CitationsCitedChunk" } }, "inlineCitations": { "description": "Optional. List of inline citations in the agent response.", "items": { "$ref": "CitationsInlineCitation" }, "type": "array" } }, "type": "object", "description": "Citations associated with the agent response." }, "ToolResponses": { "id": "ToolResponses", "properties": { "toolResponses": { "items": { "$ref": "ToolResponse" }, "description": "Optional. The list of tool execution results.", "type": "array" } }, "description": "Execution results for the requested tool calls from the client.", "type": "object" }, "RunEvaluationRequest": { "description": "Request message for EvaluationService.RunEvaluation.", "properties": { "app": { "description": "Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string" }, "runCount": { "format": "int32", "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." }, "goldenRunMethod": { "type": "string", "enum": [ "GOLDEN_RUN_METHOD_UNSPECIFIED", "STABLE", "NAIVE" ], "description": "Optional. The method to run the evaluation if it is a golden evaluation. If not set, default to STABLE.", "enumDescriptions": [ "Run method is not specified.", "Run the evaluation as stable replay, where each turn is a unique session with the previous expected turns injected as context.", "Run the evaluation as naive replay, where the run is a single session with no context injected." ] }, "optimizationConfig": { "$ref": "OptimizationConfig", "description": "Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run." }, "personaRunConfigs": { "items": { "$ref": "PersonaRunConfig" }, "description": "Optional. The configuration to use for the run per persona.", "type": "array" }, "appVersion": { "type": "string", "description": "Optional. The app version to evaluate. At most one of `app_version` or `deployment` can be set. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`" }, "displayName": { "description": "Optional. The display name of the evaluation run.", "type": "string" }, "config": { "description": "Optional. The configuration to use for the run.", "$ref": "EvaluationConfig" }, "generateLatencyReport": { "description": "Optional. Whether to generate a latency report for the evaluation run.", "type": "boolean" }, "evaluationRunCachingSettings": { "description": "Optional. The caching settings to use for the evaluation run.", "$ref": "EvaluationRunCachingSettings" }, "evaluationDataset": { "type": "string", "description": "Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`" }, "evaluations": { "description": "Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "items": { "type": "string" }, "type": "array" }, "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" } }, "id": "RunEvaluationRequest", "type": "object" }, "LfA2aV1APIKeySecurityScheme": { "description": "Defines a security scheme using an API key.", "properties": { "name": { "description": "Required. The name of the header, query, or cookie parameter to be used.", "type": "string" }, "description": { "description": "An optional description for the security scheme.", "type": "string" }, "location": { "description": "Required. The location of the API key. Valid values are \"query\", \"header\", or \"cookie\".", "type": "string" } }, "type": "object", "id": "LfA2aV1APIKeySecurityScheme" }, "OperationCompletedEvent": { "id": "OperationCompletedEvent", "description": "Event sent by the client or background worker to resume an assistant session after an asynchronous Long-Running Operation (LRO) completes.", "type": "object", "properties": { "operationName": { "description": "The operation resource name (e.g. `operations/{op}`).", "type": "string" }, "targetResourceName": { "description": "The primary resource targeted or produced by the operation (e.g. evaluation run ID, app ID, dataset ID).", "type": "string" }, "deduplicationToken": { "description": "Optional deduplication token (e.g. UUID) to prevent duplicate turn execution from concurrent browser tabs.", "type": "string" }, "operationType": { "type": "string", "description": "The operation type or tool name (e.g. \"run_evaluation\", \"copy_app\", \"export_app\")." }, "status": { "description": "Status of the operation run (e.g. \"SUCCEEDED\", \"FAILED\", \"CANCELLED\").", "type": "string" }, "error": { "description": "Optional canonical error status if the operation failed.", "$ref": "Status" }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional structured result metadata (e.g. pass_rate, total_examples, export_uri)." } } }, "GenerateChatTokenRequest": { "description": "Request message for WidgetService.GenerateChatToken.", "properties": { "recaptchaToken": { "description": "Optional. The reCAPTCHA token generated by the client-side chat widget.", "type": "string" }, "liveHandoffEnabled": { "type": "boolean", "description": "Optional. Indicates if live handoff is enabled for the session." }, "deployment": { "type": "string", "description": "Required. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}" } }, "type": "object", "id": "GenerateChatTokenRequest" }, "Toolset": { "description": "A toolset represents a group of dynamically managed tools that can be used by the agent.", "id": "Toolset", "properties": { "createTime": { "readOnly": true, "description": "Output only. Timestamp when the toolset was created.", "format": "google-datetime", "type": "string" }, "openApiToolset": { "$ref": "OpenApiToolset", "description": "Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema." }, "name": { "description": "Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string" }, "etag": { "type": "string", "description": "ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes." }, "updateTime": { "description": "Output only. Timestamp when the toolset was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "connectorToolset": { "$ref": "ConnectorToolset", "description": "Optional. A toolset that generates tools from an Integration Connectors Connection." }, "timeout": { "description": "Optional. The timeout for the toolset execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` toolsets and 60 seconds for `ASYNCHRONOUS` toolsets.", "format": "google-duration", "type": "string" }, "displayName": { "description": "Optional. The display name of the toolset. Must be unique within the same app.", "type": "string" }, "description": { "type": "string", "description": "Optional. The description of the toolset." }, "toolFakeConfig": { "description": "Optional. Configuration for tools behavior in fake mode.", "$ref": "ToolFakeConfig" }, "executionType": { "type": "string", "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." ], "description": "Optional. The execution type of the tools in the toolset." }, "mcpToolset": { "description": "Optional. A toolset that contains a list of tools that are offered by the MCP server.", "$ref": "McpToolset" } }, "type": "object" }, "GoogleSearchToolPromptConfig": { "id": "GoogleSearchToolPromptConfig", "type": "object", "description": "Prompt settings used by the model when processing or summarizing the google search results.", "properties": { "textPrompt": { "type": "string", "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." }, "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" } } }, "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.", "type": "string", "format": "byte" } }, "type": "object", "id": "ExportEvaluationRunsResponse" }, "LfA2aV1ClientCredentialsOAuthFlow": { "properties": { "scopes": { "additionalProperties": { "type": "string" }, "description": "Required. The available scopes for the OAuth2 security scheme.", "type": "object" }, "tokenUrl": { "type": "string", "description": "Required. The token URL to be used for this flow." }, "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens.", "type": "string" } }, "type": "object", "id": "LfA2aV1ClientCredentialsOAuthFlow", "description": "Defines configuration details for the OAuth 2.0 Client Credentials flow." }, "LfA2aV1TaskArtifactUpdateEvent": { "type": "object", "properties": { "metadata": { "description": "Optional. Metadata associated with the artifact update.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "contextId": { "type": "string", "description": "Required. The ID of the context that this task belongs to." }, "taskId": { "description": "Required. The ID of the task for this artifact.", "type": "string" }, "append": { "type": "boolean", "description": "If true, the content of this artifact should be appended to a previously sent artifact with the same ID." }, "artifact": { "$ref": "LfA2aV1Artifact", "description": "Required. The artifact that was generated or updated." }, "lastChunk": { "description": "If true, this is the final chunk of the artifact.", "type": "boolean" } }, "id": "LfA2aV1TaskArtifactUpdateEvent", "description": "A task delta where an artifact has been generated." }, "AggregatedMetricsTurnLatencyMetrics": { "properties": { "averageLatency": { "description": "Output only. The average latency of the turns.", "type": "string", "format": "google-duration", "readOnly": true } }, "type": "object", "description": "Metrics for turn latency.", "id": "AggregatedMetricsTurnLatencyMetrics" }, "EvaluationMetricsConfig": { "type": "object", "properties": { "scenarioMetricsConfig": { "description": "Optional. Configuration for the scenario metrics for the evaluation.", "$ref": "EvaluationMetricsConfigScenarioMetricsConfig" }, "goldenMetricsConfig": { "$ref": "EvaluationMetricsConfigGoldenMetricsConfig", "description": "Optional. Configuration for the golden metrics for the evaluation." } }, "description": "Configures the metrics for an evaluation.", "id": "EvaluationMetricsConfig" }, "ChannelProfileWhatsAppConfig": { "properties": { "wabaId": { "description": "Required. The WhatsApp Business Account ID.", "type": "string" }, "displayName": { "readOnly": true, "description": "Output only. The fetched Meta business page name.", "type": "string" }, "phoneNumberId": { "description": "Required. The Meta phone number ID.", "type": "string" }, "description": { "readOnly": true, "description": "Output only. The description of the Meta business page or profile.", "type": "string" }, "thumbnailUrl": { "readOnly": true, "description": "Output only. The fetched Meta business profile thumbnail URL.", "type": "string" }, "phoneNumber": { "description": "Optional. The phone number in E.164 format.", "type": "string" } }, "type": "object", "description": "Configuration specific to WhatsApp deployments.", "id": "ChannelProfileWhatsAppConfig" }, "SessionCheckpoint": { "id": "SessionCheckpoint", "description": "Session checkpoint containing inferred user intent for session title and UI.", "type": "object", "properties": { "userIntent": { "type": "string", "description": "Inferred user goal or topic for the session (e.g. \"Building E-Commerce Support Agent\")." } } }, "AssistantChunk": { "type": "object", "id": "AssistantChunk", "properties": { "typedPayload": { "description": "Optional. Typed payload which contains structured responses.", "$ref": "TypedPayload" }, "payload": { "description": "Optional. Payload which contains structured responses like the quality report, agent version name, suggested responses etc.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "createTime": { "description": "Optional. Timestamp when the chunk was created or emitted.", "format": "google-datetime", "type": "string" }, "text": { "type": "string", "description": "Optional. Text data." }, "thought": { "description": "Optional. Thought generated by the model.", "type": "string" } }, "description": "A chunk of data in an assistant message." }, "Schema": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional. The description of the data." }, "defs": { "type": "object", "additionalProperties": { "$ref": "Schema" }, "description": "Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema." }, "maximum": { "description": "Optional. Maximum value for Type.INTEGER and Type.NUMBER.", "type": "number", "format": "double" }, "anyOf": { "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", "items": { "$ref": "Schema" }, "type": "array" }, "uniqueItems": { "type": "boolean", "description": "Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY." }, "minimum": { "format": "double", "description": "Optional. Minimum value for Type.INTEGER and Type.NUMBER.", "type": "number" }, "required": { "description": "Optional. Required properties of Type.OBJECT.", "type": "array", "items": { "type": "string" } }, "ref": { "type": "string", "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." }, "properties": { "type": "object", "description": "Optional. Properties of Type.OBJECT.", "additionalProperties": { "$ref": "Schema" } }, "items": { "$ref": "Schema", "description": "Optional. Schema of the elements of Type.ARRAY." }, "prefixItems": { "items": { "$ref": "Schema" }, "description": "Optional. Schemas of initial elements of Type.ARRAY.", "type": "array" }, "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\"]}", "type": "array", "items": { "type": "string" } }, "default": { "type": "any", "description": "Optional. Default value of the data." }, "additionalProperties": { "description": "Optional. Can either be a boolean or an object, controls the presence of additional properties.", "$ref": "Schema" }, "type": { "description": "Required. The type of the data.", "enumDescriptions": [ "Type unspecified.", "String type.", "Integer type.", "Number type.", "Boolean type.", "Object type.", "Array type." ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "STRING", "INTEGER", "NUMBER", "BOOLEAN", "OBJECT", "ARRAY" ] }, "maxItems": { "format": "int64", "type": "string", "description": "Optional. Maximum number of the elements for Type.ARRAY." }, "title": { "description": "Optional. The title of the schema.", "type": "string" }, "minItems": { "type": "string", "format": "int64", "description": "Optional. Minimum number of the elements for Type.ARRAY." }, "nullable": { "type": "boolean", "description": "Optional. Indicates if the value may be null." } }, "description": "Represents a select subset of an OpenAPI 3.0 schema object.", "id": "Schema" }, "LfA2aV1Message": { "id": "LfA2aV1Message", "type": "object", "properties": { "referenceTaskIds": { "description": "A list of task IDs that this message references for additional context.", "type": "array", "items": { "type": "string" } }, "parts": { "description": "Required. Parts is the container of the message content.", "type": "array", "items": { "$ref": "LfA2aV1Part" } }, "metadata": { "description": "Optional. Any metadata to provide along with the message.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "taskId": { "type": "string", "description": "Optional. The task id of the message. If set, the message will be associated with the given task." }, "extensions": { "type": "array", "items": { "type": "string" }, "description": "The URIs of extensions that are present or contributed to this Message." }, "contextId": { "description": "Optional. The context id of the message. If set, the message will be associated with the given context.", "type": "string" }, "messageId": { "description": "Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.", "type": "string" }, "role": { "enumDescriptions": [ "The role is unspecified.", "The message is from the client to the server.", "The message is from the server to the client." ], "type": "string", "enum": [ "ROLE_UNSPECIFIED", "ROLE_USER", "ROLE_AGENT" ], "description": "Required. Identifies the sender of the message." } }, "description": "`Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it." }, "EvaluationScenario": { "description": "The config for a scenario", "properties": { "task": { "description": "Required. The task to be targeted by the scenario.", "type": "string" }, "maxTurns": { "format": "int32", "description": "Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100.", "type": "integer" }, "scenarioExecutionMode": { "enumDescriptions": [ "Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.", "Quality optimized mode.", "Speed optimized mode." ], "description": "Optional. The execution mode for scenario evaluations.", "type": "string", "enum": [ "SCENARIO_EXECUTION_MODE_UNSPECIFIED", "QUALITY_OPTIMIZED", "SPEED_OPTIMIZED" ] }, "userFacts": { "description": "Optional. The user facts to be used by the scenario.", "type": "array", "items": { "$ref": "EvaluationScenarioUserFact" } }, "evaluationExpectations": { "items": { "type": "string" }, "type": "array", "description": "Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}`" }, "variableOverrides": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Variables / Session Parameters as context for the session, keyed by variable names. Members of this struct will override any default values set by the system. Note, these are different from user facts, which are facts known to the user. Variables are parameters known to the agent: i.e. MDN (phone number) passed by the telephony system." }, "userGoalBehavior": { "description": "Optional. The expected behavior of the user goal.", "enumDescriptions": [ "Behavior unspecified. Will default to USER_GOAL_SATISFIED.", "The user goal should be completed successfully.", "The user goal should be rejected.", "Ignore the user goal status." ], "type": "string", "enum": [ "USER_GOAL_BEHAVIOR_UNSPECIFIED", "USER_GOAL_SATISFIED", "USER_GOAL_REJECTED", "USER_GOAL_IGNORED" ] }, "taskCompletionBehavior": { "deprecated": true, "enum": [ "TASK_COMPLETION_BEHAVIOR_UNSPECIFIED", "TASK_SATISFIED", "TASK_REJECTED" ], "type": "string", "enumDescriptions": [ "Behavior unspecified. Will default to TASK_SATISFIED.", "The user task should be completed successfully.", "The user task should be rejected." ], "description": "Optional. Deprecated. Use user_goal_behavior instead." }, "rubrics": { "type": "array", "description": "Required. The rubrics to score the scenario against.", "items": { "type": "string" } }, "scenarioExpectations": { "description": "Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation.", "type": "array", "items": { "$ref": "EvaluationScenarioExpectation" } } }, "id": "EvaluationScenario", "type": "object" }, "SynthesizeSpeechConfig": { "properties": { "speakingRate": { "type": "number", "description": "Optional. The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.", "format": "double" }, "model": { "type": "string", "description": "Optional. The model used to synthesize audio. Currently supported values: - \"gemini-3.1-flash-tts-preview\" If empty, Chirp3-HD is used." }, "instruction": { "type": "string", "description": "Optional. The instruction used to synthesize speech when using a generative model." }, "voice": { "type": "string", "description": "Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud Text-to-Speech." } }, "type": "object", "description": "Configuration for how the agent response should be synthesized.", "id": "SynthesizeSpeechConfig" }, "GuardrailLlmPolicy": { "description": "Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.", "properties": { "allowShortUtterance": { "description": "Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped.", "type": "boolean" }, "prompt": { "description": "Required. Policy prompt.", "type": "string" }, "policyScope": { "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.", "type": "string", "enum": [ "POLICY_SCOPE_UNSPECIFIED", "USER_QUERY", "AGENT_RESPONSE", "USER_QUERY_AND_AGENT_RESPONSE" ] }, "maxConversationMessages": { "description": "Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.", "format": "int32", "type": "integer" }, "modelSettings": { "$ref": "ModelSettings", "description": "Optional. Model settings." }, "failOpen": { "description": "Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.", "type": "boolean" } }, "id": "GuardrailLlmPolicy", "type": "object" }, "QualityReport": { "type": "object", "id": "QualityReport", "properties": { "evaluationRuns": { "items": { "type": "string" }, "description": "Optional. A list of evaluation runs used to generate the quality report. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluationRun}`.", "type": "array" }, "generalIssues": { "items": { "$ref": "QualityReportIssue" }, "description": "Optional. General issues not specific to any agent.", "type": "array" }, "issues": { "items": { "$ref": "QualityReportAgentIssues" }, "type": "array", "description": "Optional. The issues grouped by agent." } }, "description": "The report describing any identified quality issues in the app." }, "ExportEvaluationsResponse": { "type": "object", "properties": { "evaluationsContent": { "description": "The content of the exported Evaluations. This will be populated if gcs_uri was not specified in the request.", "format": "byte", "type": "string" }, "evaluationsUri": { "description": "The Google Cloud Storage URI folder where the exported evaluations were written. This will be populated if gcs_uri was specified in the request.", "type": "string" }, "failedEvaluations": { "description": "Output only. A map of evaluation resource names that could not be exported, to the reason why they failed.", "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true } }, "id": "ExportEvaluationsResponse", "description": "Response message for EvaluationService.ExportEvaluations." }, "LfA2aV1MutualTlsSecurityScheme": { "id": "LfA2aV1MutualTlsSecurityScheme", "description": "Defines a security scheme using mTLS authentication.", "properties": { "description": { "type": "string", "description": "An optional description for the security scheme." } }, "type": "object" }, "RunEvaluationResultMetricsResponse": { "type": "object", "id": "RunEvaluationResultMetricsResponse", "properties": { "status": { "type": "string", "readOnly": true, "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", "Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", "Evaluation/Expectation was skipped." ], "enum": [ "OUTCOME_UNSPECIFIED", "PASS", "FAIL", "SKIPPED" ], "description": "Output only. The status of the evaluation result metrics calculation." } }, "description": "Response message for EvaluationService.RunEvaluationResultMetrics." }, "AgentRegistryDeployment": { "type": "object", "properties": { "agentRegistryServiceName": { "type": "string", "description": "Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}`", "readOnly": true } }, "description": "Configuration and status for Agent Registry deployment.", "id": "AgentRegistryDeployment" }, "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.", "id": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig", "type": "object", "properties": { "enableSemanticSimilarityMetrics": { "description": "Optional. Whether to calculate semantic similarity metrics for the evaluation.", "type": "boolean" } } }, "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", "description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", "format": "float" } }, "id": "DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "type": "object" }, "DataStoreToolSummarizationConfig": { "type": "object", "properties": { "modelSettings": { "$ref": "ModelSettings", "description": "Optional. Configurations for the LLM model." }, "disabled": { "type": "boolean", "description": "Optional. Whether summarization is disabled." }, "prompt": { "description": "Optional. The prompt definition. If not set, default prompt will be used.", "type": "string" } }, "description": "Summarization configuration.", "id": "DataStoreToolSummarizationConfig" }, "LfA2aV1AgentCardSignature": { "id": "LfA2aV1AgentCardSignature", "properties": { "header": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "The unprotected JWS header values." }, "protected": { "description": "Required. Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object.", "type": "string" }, "signature": { "description": "Required. The computed signature, base64url-encoded.", "type": "string" } }, "type": "object", "description": "AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS)." }, "RetrieveToolsRequest": { "id": "RetrieveToolsRequest", "type": "object", "properties": { "toolIds": { "items": { "type": "string" }, "type": "array", "description": "Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned." }, "bypassPersistenceConfig": { "description": "Optional. If true, the returned tools will contain raw descriptions and schemas directly from the server, bypassing any stored persistence configurations (overrides/snapshots).", "type": "boolean" } }, "description": "Request message for ToolService.RetrieveTools." }, "ExperimentConfigVersionReleaseTrafficAllocation": { "description": "Traffic allocation for the version release.", "id": "ExperimentConfigVersionReleaseTrafficAllocation", "properties": { "trafficPercentage": { "format": "int32", "type": "integer", "description": "Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100." }, "appVersion": { "description": "Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "id": { "description": "Optional. Id of the traffic allocation. Free format string, up to 128 characters.", "type": "string" } }, "type": "object" } }, "id": "ces:v1beta", "description": "", "resources": { "projects": { "resources": { "locations": { "resources": { "apps": { "resources": { "evaluationExpectations": { "methods": { "create": { "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations", "path": "v1beta/{+parent}/evaluationExpectations", "parameterOrder": [ "parent" ], "description": "Creates an evaluation expectation.", "id": "ces.projects.locations.apps.evaluationExpectations.create", "parameters": { "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." }, "parent": { "description": "Required. The app to create the evaluation expectation for. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "EvaluationExpectation" }, "request": { "$ref": "EvaluationExpectation" } }, "list": { "httpMethod": "GET", "description": "Lists all evaluation expectations in the given app.", "id": "ces.projects.locations.apps.evaluationExpectations.list", "parameters": { "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" }, "parent": { "description": "Required. The resource name of the app to list evaluation expectations from.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true, "type": "string" }, "filter": { "location": "query", "description": "Optional. Filter to be applied when listing the evaluation expectations. See https://google.aip.dev/160 for more details.", "type": "string" }, "pageSize": { "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationExpectations call.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations", "response": { "$ref": "ListEvaluationExpectationsResponse" }, "path": "v1beta/{+parent}/evaluationExpectations" }, "get": { "response": { "$ref": "EvaluationExpectation" }, "description": "Gets details of the specified evaluation expectation.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}", "parameters": { "name": { "description": "Required. The resource name of the evaluation expectation to retrieve.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$", "required": true, "type": "string" } }, "id": "ces.projects.locations.apps.evaluationExpectations.get", "path": "v1beta/{+name}" }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "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": { "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.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}", "description": "Deletes an evaluation expectation.", "id": "ces.projects.locations.apps.evaluationExpectations.delete" }, "patch": { "description": "Updates an evaluation expectation.", "response": { "$ref": "EvaluationExpectation" }, "request": { "$ref": "EvaluationExpectation" }, "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationExpectations/{evaluationExpectationsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "id": "ces.projects.locations.apps.evaluationExpectations.patch", "parameters": { "name": { "description": "Identifier. The unique identifier of this evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationExpectations/[^/]+$", "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.", "type": "string", "location": "query", "format": "google-fieldmask" } }, "path": "v1beta/{+name}" } } }, "conversations": { "methods": { "generateEvaluation": { "response": { "$ref": "Operation" }, "id": "ces.projects.locations.apps.conversations.generateEvaluation", "request": { "$ref": "GenerateEvaluationRequest" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}:generateEvaluation", "path": "v1beta/{+conversation}:generateEvaluation", "parameterOrder": [ "conversation" ], "httpMethod": "POST", "parameters": { "conversation": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$", "type": "string", "description": "Required. The conversation to create the golden evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`", "location": "path" } }, "description": "Creates a golden evaluation from a conversation." }, "list": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations", "parameterOrder": [ "parent" ], "httpMethod": "GET", "description": "Lists conversations in the given app.", "response": { "$ref": "ListConversationsResponse" }, "path": "v1beta/{+parent}/conversations", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListConversations call." }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "source": { "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "location": "query", "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "type": "string", "description": "Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of `sources` field." }, "parent": { "location": "path", "description": "Required. The resource name of the app to list conversations from.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true, "type": "string" }, "filter": { "description": "Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details.", "type": "string", "location": "query" }, "sources": { "description": "Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default.", "repeated": true, "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "location": "query", "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." ] } }, "id": "ces.projects.locations.apps.conversations.list" }, "delete": { "description": "Deletes the specified conversation.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}", "parameters": { "source": { "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "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." ], "type": "string", "location": "query", "description": "Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default." }, "name": { "description": "Required. The resource name of the conversation to delete.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$" } }, "httpMethod": "DELETE", "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.conversations.delete", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" } }, "get": { "parameters": { "source": { "description": "Optional. Indicate the source of the conversation. If not set, all source will be searched.", "enum": [ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", "EVAL", "AGENT_TOOL" ], "deprecated": true, "type": "string", "location": "query", "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", "The conversation is from the evaluation.", "The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ] }, "name": { "description": "Required. The resource name of the conversation to retrieve.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.conversations.get", "response": { "$ref": "Conversation" }, "description": "Gets details of the specified conversation.", "path": "v1beta/{+name}" }, "batchDelete": { "httpMethod": "POST", "id": "ces.projects.locations.apps.conversations.batchDelete", "request": { "$ref": "BatchDeleteConversationsRequest" }, "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true } }, "response": { "$ref": "Operation" }, "description": "Batch deletes the specified conversations.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations:batchDelete", "path": "v1beta/{+parent}/conversations:batchDelete" } } }, "examples": { "methods": { "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$", "type": "string", "required": true, "description": "Required. The resource name of the example to delete." }, "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.", "type": "string", "location": "query" } }, "description": "Deletes the specified example.", "id": "ces.projects.locations.apps.examples.delete", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "httpMethod": "PATCH", "id": "ces.projects.locations.apps.examples.patch", "response": { "$ref": "Example" }, "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "type": "string" }, "name": { "description": "Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$", "required": true, "location": "path" } }, "description": "Updates the specified example.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "request": { "$ref": "Example" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}" }, "list": { "parameters": { "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" }, "parent": { "description": "Required. The resource name of the app to list examples from.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListExamples call.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details.", "location": "query", "type": "string" }, "orderBy": { "type": "string", "location": "query", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details." } }, "response": { "$ref": "ListExamplesResponse" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "ces.projects.locations.apps.examples.list", "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}/examples", "description": "Lists examples in the given app.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples" }, "create": { "parameterOrder": [ "parent" ], "response": { "$ref": "Example" }, "description": "Creates a new example in the given app.", "request": { "$ref": "Example" }, "path": "v1beta/{+parent}/examples", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples", "httpMethod": "POST", "id": "ces.projects.locations.apps.examples.create", "parameters": { "parent": { "description": "Required. The resource name of the app to create an example in.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true }, "exampleId": { "type": "string", "location": "query", "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." } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets details of the specified example.", "response": { "$ref": "Example" }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}", "parameters": { "name": { "description": "Required. The resource name of the example to retrieve.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.examples.get", "httpMethod": "GET" } } }, "toolsets": { "methods": { "get": { "description": "Gets details of the specified toolset.", "path": "v1beta/{+name}", "response": { "$ref": "Toolset" }, "parameters": { "name": { "required": true, "description": "Required. The resource name of the toolset to retrieve.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.toolsets.get", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}" }, "delete": { "description": "Deletes the specified toolset.", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "force": { "description": "Optional. Indicates whether to forcefully delete the toolset, even if it is still referenced by app/agents. * If `force = false`, the deletion fails if any agents still reference the toolset. * If `force = true`, all existing references from agents will be removed and the toolset will be deleted.", "location": "query", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the toolset to delete.", "required": true }, "etag": { "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.", "location": "query" } }, "httpMethod": "DELETE", "id": "ces.projects.locations.apps.toolsets.delete", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}", "path": "v1beta/{+name}" }, "create": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets", "description": "Creates a new toolset in the given app.", "id": "ces.projects.locations.apps.toolsets.create", "request": { "$ref": "Toolset" }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "Toolset" }, "path": "v1beta/{+parent}/toolsets", "parameters": { "parent": { "type": "string", "description": "Required. The resource name of the app to create a toolset in.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "toolsetId": { "description": "Optional. The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset.", "type": "string", "location": "query" } } }, "patch": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.toolsets.patch", "path": "v1beta/{+name}", "response": { "$ref": "Toolset" }, "description": "Updates the specified toolset.", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "type": "string", "location": "query", "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", "description": "Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "required": true, "location": "path" } }, "request": { "$ref": "Toolset" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}", "httpMethod": "PATCH" }, "list": { "parameters": { "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": { "type": "string", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListToolsets call.", "location": "query" }, "parent": { "location": "path", "description": "Required. The resource name of the app to list toolsets from.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true, "type": "string" }, "filter": { "location": "query", "description": "Optional. Filter to be applied when listing the toolsets. See https://google.aip.dev/160 for more details.", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "location": "query", "format": "int32" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets", "description": "Lists toolsets in the given app.", "httpMethod": "GET", "path": "v1beta/{+parent}/toolsets", "response": { "$ref": "ListToolsetsResponse" }, "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.toolsets.list", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "retrieveTools": { "parameters": { "toolset": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the toolset to retrieve the tools for. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string" } }, "id": "ces.projects.locations.apps.toolsets.retrieveTools", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "RetrieveToolsResponse" }, "description": "Retrieve the list of tools included in the specified toolset.", "httpMethod": "POST", "request": { "$ref": "RetrieveToolsRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}:retrieveTools", "path": "v1beta/{+toolset}:retrieveTools", "parameterOrder": [ "toolset" ] } } }, "message": { "methods": { "stream": { "parameters": { "tenant": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "type": "string", "location": "path", "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set." } }, "response": { "$ref": "LfA2aV1StreamResponse" }, "id": "ces.projects.locations.apps.message.stream", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "tenant" ], "path": "v1beta/{+tenant}/message:stream", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/message:stream", "request": { "$ref": "LfA2aV1SendMessageRequest" }, "description": "Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`" }, "send": { "request": { "$ref": "LfA2aV1SendMessageRequest" }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/message:send", "id": "ces.projects.locations.apps.message.send", "parameters": { "tenant": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path" } }, "description": "Sends a message to an agent.", "path": "v1beta/{+tenant}/message:send", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "tenant" ], "response": { "$ref": "LfA2aV1SendMessageResponse" } } } }, "tools": { "methods": { "create": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "type": "string", "required": true, "description": "Required. The resource name of the app to create a tool in." }, "toolId": { "type": "string", "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" } }, "response": { "$ref": "Tool" }, "request": { "$ref": "Tool" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.tools.create", "path": "v1beta/{+parent}/tools", "description": "Creates a new tool in the given app." }, "patch": { "request": { "$ref": "Tool" }, "response": { "$ref": "Tool" }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.tools.patch", "httpMethod": "PATCH", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "description": "Updates the specified tool.", "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": { "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.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of the specified tool.", "parameters": { "name": { "type": "string", "description": "Required. The resource name of the tool to retrieve.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "location": "path" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "httpMethod": "GET", "response": { "$ref": "Tool" }, "id": "ces.projects.locations.apps.tools.get", "path": "v1beta/{+name}" }, "list": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools", "description": "Lists tools in the given app.", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "orderBy": { "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.", "location": "query" }, "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The resource name of the app to list tools from." }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "location": "query", "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.", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListTools call." } }, "id": "ces.projects.locations.apps.tools.list", "response": { "$ref": "ListToolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+parent}/tools" }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}", "description": "Deletes the specified tool.", "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "description": "Required. The resource name of the tool to delete.", "location": "path", "type": "string", "required": true }, "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." }, "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." } }, "id": "ces.projects.locations.apps.tools.delete", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE" } } }, "guardrails": { "methods": { "create": { "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "type": "string", "description": "Required. The resource name of the app to create a guardrail in.", "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" } }, "description": "Creates a new guardrail in the given app.", "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", "response": { "$ref": "Guardrail" }, "parameterOrder": [ "parent" ], "request": { "$ref": "Guardrail" }, "path": "v1beta/{+parent}/guardrails" }, "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.guardrails.get", "httpMethod": "GET", "description": "Gets details of the specified guardrail.", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "description": "Required. The resource name of the guardrail to retrieve.", "location": "path", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Guardrail" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "ces.projects.locations.apps.guardrails.list", "path": "v1beta/{+parent}/guardrails", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails", "description": "Lists guardrails in the given app.", "response": { "$ref": "ListGuardrailsResponse" }, "parameters": { "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": { "type": "string", "location": "query", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details." }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListGuardrails call.", "type": "string" }, "parent": { "description": "Required. The resource name of the app to list guardrails from.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true }, "filter": { "description": "Optional. Filter to be applied when listing the guardrails. See https://google.aip.dev/160 for more details.", "type": "string", "location": "query" } }, "httpMethod": "GET" }, "patch": { "httpMethod": "PATCH", "path": "v1beta/{+name}", "parameters": { "updateMask": { "type": "string", "location": "query", "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": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "description": "Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`", "location": "path", "type": "string", "required": true } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "request": { "$ref": "Guardrail" }, "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.guardrails.patch", "response": { "$ref": "Guardrail" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the specified guardrail." }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes the specified guardrail.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}", "path": "v1beta/{+name}", "parameters": { "force": { "type": "boolean", "location": "query", "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." }, "name": { "location": "path", "description": "Required. The resource name of the guardrail to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$", "type": "string", "required": true }, "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" } }, "id": "ces.projects.locations.apps.guardrails.delete" } } }, "scheduledEvaluationRuns": { "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.scheduledEvaluationRuns.patch", "parameterOrder": [ "name" ], "response": { "$ref": "ScheduledEvaluationRun" }, "path": "v1beta/{+name}", "request": { "$ref": "ScheduledEvaluationRun" }, "description": "Updates a scheduled evaluation run.", "httpMethod": "PATCH", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}", "parameters": { "updateMask": { "location": "query", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "type": "string", "format": "google-fieldmask" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$", "description": "Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}", "location": "path", "required": true, "type": "string" } } }, "create": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ScheduledEvaluationRun" }, "parameters": { "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The app to create the scheduled evaluation run for. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true }, "scheduledEvaluationRunId": { "location": "query", "type": "string", "description": "Optional. The ID to use for the scheduled evaluation run, which will become the final component of the scheduled evaluation run's resource name. If not provided, a unique ID will be automatically assigned." } }, "response": { "$ref": "ScheduledEvaluationRun" }, "description": "Creates a scheduled evaluation run.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns", "path": "v1beta/{+parent}/scheduledEvaluationRuns", "id": "ces.projects.locations.apps.scheduledEvaluationRuns.create" }, "get": { "description": "Gets details of the specified scheduled evaluation run.", "response": { "$ref": "ScheduledEvaluationRun" }, "id": "ces.projects.locations.apps.scheduledEvaluationRuns.get", "parameters": { "name": { "description": "Required. The resource name of the scheduled evaluation run to retrieve.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$", "type": "string" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}", "parameterOrder": [ "name" ] }, "list": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns", "description": "Lists all scheduled evaluation runs in the given app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+parent}/scheduledEvaluationRuns", "parameterOrder": [ "parent" ], "parameters": { "orderBy": { "description": "Optional. Field to sort by. Supported fields are: \"name\" (ascending), \"create_time\" (descending), \"update_time\" (descending), \"next_scheduled_execution\" (ascending), and \"last_completed_run.create_time\" (descending). If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" }, "filter": { "description": "Optional. Filter to be applied when listing the scheduled evaluation runs. See https://google.aip.dev/160 for more details. Currently supports filtering by: * request.evaluations:evaluation_id * request.evaluation_dataset:evaluation_dataset_id", "type": "string", "location": "query" }, "parent": { "location": "path", "description": "Required. The resource name of the app to list scheduled evaluation runs from.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "type": "string", "required": true }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListScheduledEvaluationRuns call.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "type": "integer", "location": "query" } }, "id": "ces.projects.locations.apps.scheduledEvaluationRuns.list", "response": { "$ref": "ListScheduledEvaluationRunsResponse" }, "httpMethod": "GET" }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" }, "parameters": { "name": { "description": "Required. The resource name of the scheduled evaluation run to delete.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/scheduledEvaluationRuns/[^/]+$", "location": "path", "type": "string" }, "etag": { "description": "Optional. The etag of the ScheduledEvaluationRun. If provided, it must match the server's etag.", "location": "query", "type": "string" } }, "id": "ces.projects.locations.apps.scheduledEvaluationRuns.delete", "path": "v1beta/{+name}", "description": "Deletes a scheduled evaluation run.", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/scheduledEvaluationRuns/{scheduledEvaluationRunsId}" } } }, "deployments": { "resources": { "message": { "methods": { "send": { "parameterOrder": [ "tenant" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/message:send", "request": { "$ref": "LfA2aV1SendMessageRequest" }, "id": "ces.projects.locations.apps.deployments.message.send", "description": "Sends a message to an agent.", "response": { "$ref": "LfA2aV1SendMessageResponse" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "tenant": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "location": "path", "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set." } }, "path": "v1beta/{+tenant}/message:send", "httpMethod": "POST" }, "stream": { "response": { "$ref": "LfA2aV1StreamResponse" }, "id": "ces.projects.locations.apps.deployments.message.stream", "path": "v1beta/{+tenant}/message:stream", "description": "Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`", "parameterOrder": [ "tenant" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "tenant": { "location": "path", "required": true, "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/message:stream", "request": { "$ref": "LfA2aV1SendMessageRequest" } } } } }, "methods": { "patch": { "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "httpMethod": "PATCH", "response": { "$ref": "Deployment" }, "parameters": { "updateMask": { "format": "google-fieldmask", "type": "string", "location": "query", "description": "Optional. The list of fields to update." }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "type": "string", "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "location": "path" } }, "description": "Updates the specified deployment.", "id": "ces.projects.locations.apps.deployments.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" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "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}`", "type": "string", "required": true }, "etag": { "location": "query", "description": "Optional. The etag of the deployment. If an etag is provided and does not match the current etag of the deployment, deletion will be blocked and an ABORTED error will be returned.", "type": "string" } }, "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "description": "Deletes the specified deployment.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "id": "ces.projects.locations.apps.deployments.delete", "parameterOrder": [ "name" ], "path": "v1beta/{+name}" }, "get": { "description": "Gets details of the specified deployment.", "parameterOrder": [ "name" ], "path": "v1beta/{+name}", "response": { "$ref": "Deployment" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}", "httpMethod": "GET", "id": "ces.projects.locations.apps.deployments.get", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "location": "path" } } }, "getExtendedAgentCard": { "id": "ces.projects.locations.apps.deployments.getExtendedAgentCard", "parameterOrder": [ "tenant" ], "response": { "$ref": "LfA2aV1AgentCard" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+tenant}/extendedAgentCard", "description": "Gets the extended agent card for the authenticated agent.", "parameters": { "tenant": { "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "type": "string", "required": true } }, "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/extendedAgentCard" }, "list": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" }, "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." }, "parent": { "required": true, "description": "Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeployments` must match the call that provided the page token.", "type": "string" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments", "path": "v1beta/{+parent}/deployments", "httpMethod": "GET", "description": "Lists deployments in the given app.", "id": "ces.projects.locations.apps.deployments.list", "response": { "$ref": "ListDeploymentsResponse" } }, "create": { "response": { "$ref": "Deployment" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "type": "string", "required": true, "description": "Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "deploymentId": { "description": "Optional. The ID to use for the deployment, which will become the final component of the deployment's resource name. If not provided, a unique ID will be automatically assigned for the deployment.", "location": "query", "type": "string" } }, "path": "v1beta/{+parent}/deployments", "httpMethod": "POST", "request": { "$ref": "Deployment" }, "description": "Creates a new deployment in the given app.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments", "id": "ces.projects.locations.apps.deployments.create" } } }, "agents": { "methods": { "get": { "description": "Gets details of the specified agent.", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "type": "string", "required": true, "description": "Required. The resource name of the agent to retrieve." } }, "response": { "$ref": "Agent" }, "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.agents.get" }, "create": { "parameters": { "agentId": { "location": "query", "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.", "type": "string" }, "parent": { "location": "path", "description": "Required. The resource name of the app to create an agent in.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "type": "string", "required": true } }, "description": "Creates a new agent in the given app.", "id": "ces.projects.locations.apps.agents.create", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents", "httpMethod": "POST", "response": { "$ref": "Agent" }, "parameterOrder": [ "parent" ], "request": { "$ref": "Agent" }, "path": "v1beta/{+parent}/agents" }, "patch": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}", "request": { "$ref": "Agent" }, "parameterOrder": [ "name" ], "response": { "$ref": "Agent" }, "description": "Updates the specified agent.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.agents.patch", "httpMethod": "PATCH", "path": "v1beta/{+name}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "type": "string", "description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "required": true }, "updateMask": { "format": "google-fieldmask", "location": "query", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "type": "string" } } }, "delete": { "parameters": { "force": { "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.", "location": "query" }, "name": { "description": "Required. The resource name of the agent to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$", "location": "path", "type": "string", "required": true }, "etag": { "type": "string", "location": "query", "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." } }, "description": "Deletes the specified agent.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "id": "ces.projects.locations.apps.agents.delete", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListAgents call." }, "parent": { "description": "Required. The resource name of the app to list agents from.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true }, "pageSize": { "format": "int32", "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details." }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents", "path": "v1beta/{+parent}/agents", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListAgentsResponse" }, "description": "Lists agents in the given app.", "id": "ces.projects.locations.apps.agents.list" } } }, "sessions": { "methods": { "generateChatToken": { "httpMethod": "POST", "response": { "$ref": "GenerateChatTokenResponse" }, "id": "ces.projects.locations.apps.sessions.generateChatToken", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "description": "Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}", "location": "path", "type": "string", "required": true } }, "description": "Generates a session scoped token for chat widget to authenticate with Session APIs.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GenerateChatTokenRequest" }, "path": "v1beta/{+name}:generateChatToken", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:generateChatToken" }, "streamRunSession": { "httpMethod": "POST", "response": { "$ref": "RunSessionResponse" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "RunSessionRequest" }, "parameters": { "session": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`", "location": "path" } }, "path": "v1beta/{+session}:streamRunSession", "parameterOrder": [ "session" ], "id": "ces.projects.locations.apps.sessions.streamRunSession", "description": "Initiates a single-turn interaction with the CES agent. Uses server-side streaming to deliver incremental results and partial responses as they are generated. By default, complete responses (e.g., messages from callbacks or full LLM responses) are sent to the client as soon as they are available. To enable streaming individual text chunks directly from the model, set enable_text_streaming to true.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:streamRunSession" }, "runSession": { "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:runSession", "request": { "$ref": "RunSessionRequest" }, "description": "Initiates a single-turn interaction with the CES agent within a session.", "parameters": { "session": { "location": "path", "type": "string", "description": "Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$", "required": true } }, "id": "ces.projects.locations.apps.sessions.runSession", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "session" ], "path": "v1beta/{+session}:runSession", "response": { "$ref": "RunSessionResponse" } } } }, "evaluations": { "methods": { "patch": { "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "required": true, "description": "Identifier. The unique identifier of this evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "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" } }, "id": "ces.projects.locations.apps.evaluations.patch", "response": { "$ref": "Evaluation" }, "httpMethod": "PATCH", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}", "description": "Updates an evaluation.", "request": { "$ref": "Evaluation" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "parameterOrder": [ "name" ] }, "create": { "response": { "$ref": "Evaluation" }, "path": "v1beta/{+parent}/evaluations", "parameters": { "parent": { "description": "Required. The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" }, "evaluationId": { "type": "string", "location": "query", "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." } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.evaluations.create", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations", "description": "Creates an evaluation.", "request": { "$ref": "Evaluation" } }, "list": { "id": "ces.projects.locations.apps.evaluations.list", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Lists all evaluations in the given app.", "httpMethod": "GET", "path": "v1beta/{+parent}/evaluations", "response": { "$ref": "ListEvaluationsResponse" }, "parameters": { "filter": { "description": "Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.", "type": "string", "location": "query", "deprecated": true }, "parent": { "required": true, "description": "Required. The resource name of the app to list evaluations from.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" }, "lastTenResults": { "description": "Optional. Whether to include the last 10 evaluation results for each evaluation in the response.", "location": "query", "type": "boolean" }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\", and \"update_time\" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.", "type": "string" }, "evaluationFilter": { "description": "Optional. Filter to be applied on the evaluation when listing the evaluations. See https://google.aip.dev/160 for more details. Supported fields: evaluation_datasets", "location": "query", "type": "string" }, "evaluationRunFilter": { "description": "Optional. Filter string for fields on the associated EvaluationRun resources. See https://google.aip.dev/160 for more details. Supported fields: create_time, initiated_by, app_version_display_name", "location": "query", "type": "string" }, "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" } } }, "uploadEvaluationAudio": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "location": "path", "description": "Required. The resource name of the Evaluation for which to upload the evaluation audio. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "type": "string" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}:uploadEvaluationAudio", "path": "v1beta/{+name}:uploadEvaluationAudio", "response": { "$ref": "UploadEvaluationAudioResponse" }, "id": "ces.projects.locations.apps.evaluations.uploadEvaluationAudio", "parameterOrder": [ "name" ], "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.", "request": { "$ref": "UploadEvaluationAudioRequest" } }, "get": { "parameters": { "name": { "description": "Required. The resource name of the evaluation to retrieve.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "required": true } }, "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" ], "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.evaluations.get", "description": "Gets details of the specified evaluation.", "response": { "$ref": "Evaluation" }, "path": "v1beta/{+name}" }, "delete": { "response": { "$ref": "Empty" }, "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an evaluation.", "id": "ces.projects.locations.apps.evaluations.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "force": { "description": "Optional. Indicates whether to forcefully delete the evaluation, even if it is still referenced by evaluation datasets. * If `force = false`, the deletion will fail if any datasets still reference the evaluation. * If `force = true`, all existing references from datasets will be removed and the evaluation will be deleted.", "type": "boolean", "location": "query" }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "description": "Required. The resource name of the evaluation to delete.", "type": "string", "location": "path" }, "etag": { "location": "query", "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.", "type": "string" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}" }, "export": { "response": { "$ref": "Operation" }, "id": "ces.projects.locations.apps.evaluations.export", "parameterOrder": [ "parent" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Exports evaluations.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations:export", "path": "v1beta/{+parent}/evaluations:export", "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to export evaluations from. Format: `projects/{project}/locations/{location}/apps/{app}`", "location": "path", "type": "string" } }, "request": { "$ref": "ExportEvaluationsRequest" } } }, "resources": { "results": { "methods": { "runEvaluationResultMetrics": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Runs metrics on an existing evaluation result.", "request": { "$ref": "RunEvaluationResultMetricsRequest" }, "parameterOrder": [ "evaluationResultId" ], "response": { "$ref": "Operation" }, "id": "ces.projects.locations.apps.evaluations.results.runEvaluationResultMetrics", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}:runEvaluationResultMetrics", "httpMethod": "POST", "parameters": { "evaluationResultId": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The evaluation result to run metrics for. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result_id}`" } }, "path": "v1beta/{+evaluationResultId}:runEvaluationResultMetrics" }, "list": { "id": "ces.projects.locations.apps.evaluations.results.list", "parameters": { "pageSize": { "format": "int32", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query" }, "orderBy": { "location": "query", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\", and \"update_time\" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details.", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationResults call." }, "parent": { "required": true, "location": "path", "type": "string", "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/-`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$" }, "filter": { "description": "Optional. Filter to be applied when listing the evaluation results. See https://google.aip.dev/160 for more details.", "location": "query", "type": "string" } }, "description": "Lists all evaluation results for a given evaluation.", "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "ListEvaluationResultsResponse" }, "path": "v1beta/{+parent}/results", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "id": "ces.projects.locations.apps.evaluations.results.delete", "parameters": { "name": { "description": "Required. The resource name of the evaluation result to delete.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$", "type": "string", "location": "path" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "description": "Deletes an evaluation result." }, "get": { "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}", "id": "ces.projects.locations.apps.evaluations.results.get", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the evaluation result to retrieve.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$", "type": "string" } }, "description": "Gets details of the specified evaluation result.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "EvaluationResult" }, "parameterOrder": [ "name" ] }, "export": { "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", "required": true, "description": "Required. The resource name of the evaluation to export evaluation results from. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`" } }, "id": "ces.projects.locations.apps.evaluations.results.export", "httpMethod": "POST", "path": "v1beta/{+parent}/results:export", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results:export", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Exports evaluations results.", "request": { "$ref": "ExportEvaluationResultsRequest" } } } } } }, "evaluationDatasets": { "methods": { "list": { "description": "Lists all evaluation datasets in the given app.", "response": { "$ref": "ListEvaluationDatasetsResponse" }, "path": "v1beta/{+parent}/evaluationDatasets", "parameterOrder": [ "parent" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "filter": { "location": "query", "description": "Optional. Filter to be applied when listing the evaluation datasets. See https://google.aip.dev/160 for more details.", "type": "string" }, "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to list evaluation datasets from.", "required": true }, "orderBy": { "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.", "location": "query" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationDatasets call.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets", "id": "ces.projects.locations.apps.evaluationDatasets.list" }, "create": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" }, "evaluationDatasetId": { "location": "query", "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.", "type": "string" } }, "id": "ces.projects.locations.apps.evaluationDatasets.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an evaluation dataset.", "path": "v1beta/{+parent}/evaluationDatasets", "response": { "$ref": "EvaluationDataset" }, "request": { "$ref": "EvaluationDataset" } }, "patch": { "httpMethod": "PATCH", "id": "ces.projects.locations.apps.evaluationDatasets.patch", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}", "parameters": { "updateMask": { "type": "string", "location": "query", "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": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$", "required": true, "description": "Identifier. The unique identifier of this evaluation dataset. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "type": "string" } }, "description": "Updates an evaluation dataset.", "path": "v1beta/{+name}", "response": { "$ref": "EvaluationDataset" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "EvaluationDataset" }, "parameterOrder": [ "name" ] }, "get": { "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$", "description": "Required. The resource name of the evaluation dataset to retrieve.", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "EvaluationDataset" }, "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}", "description": "Gets details of the specified evaluation dataset.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.evaluationDatasets.get" }, "delete": { "response": { "$ref": "Empty" }, "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.evaluationDatasets.delete", "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationDatasets/{evaluationDatasetsId}", "parameters": { "name": { "type": "string", "description": "Required. The resource name of the evaluation dataset to delete.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationDatasets/[^/]+$" }, "etag": { "location": "query", "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.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an evaluation dataset.", "httpMethod": "DELETE" } } }, "assistantSessions": { "methods": { "list": { "id": "ces.projects.locations.apps.assistantSessions.list", "httpMethod": "GET", "response": { "$ref": "ListAssistantSessionsResponse" }, "description": "Lists all assistant sessions in the given app.", "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "type": "string", "description": "Optional. The next_page_token value returned from a previous list AssistantService.ListAssistantSessions call.", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "type": "string", "description": "Required. The app to list assistant sessions from. Format: `projects/{project}/locations/{location}/apps/{app}`", "location": "path", "required": true }, "filter": { "description": "Optional. Filter to be applied when listing the assistant sessions. See https://google.aip.dev/160 for more details.", "location": "query", "type": "string" } }, "path": "v1beta/{+parent}/assistantSessions", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/assistantSessions", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "description": "Creates a new assistant session in the given app.", "request": { "$ref": "CreateAssistantSessionRequest" }, "response": { "$ref": "AssistantSession" }, "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}/assistantSessions", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "description": "Required. The app to create the assistant session in Format: `projects/{project}/locations/{location}/apps/{app}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/assistantSessions", "id": "ces.projects.locations.apps.assistantSessions.create", "httpMethod": "POST" }, "get": { "httpMethod": "GET", "response": { "$ref": "AssistantSession" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/assistantSessions/[^/]+$", "type": "string", "description": "Required. The name of the assistant session to retrieve. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}`", "required": true } }, "id": "ces.projects.locations.apps.assistantSessions.get", "description": "Gets details of the specified assistant session.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/assistantSessions/{assistantSessionsId}" }, "streamChatAiAssistant": { "id": "ces.projects.locations.apps.assistantSessions.streamChatAiAssistant", "path": "v1beta/{+name}:streamChatAiAssistant", "response": { "$ref": "StreamChatAiAssistantResponse" }, "parameters": { "name": { "description": "Required. The assistant session to be used to run the assistant. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/assistantSessions/[^/]+$", "type": "string", "required": true } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/assistantSessions/{assistantSessionsId}:streamChatAiAssistant", "parameterOrder": [ "name" ], "request": { "$ref": "StreamChatAiAssistantRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Runs the Chat AI assistant agent for the specified assistant session in a streaming fashion." }, "delete": { "parameters": { "name": { "type": "string", "description": "Required. The name of the assistant session to delete. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/assistantSessions/[^/]+$", "required": true, "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/assistantSessions/{assistantSessionsId}", "description": "Deletes the specified assistant session.", "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.assistantSessions.delete" }, "cancelAssistantTurn": { "description": "Cancels the assistant session's in-flight turn, if any: the explicit user stop for a turn running detached from any stream. A cancel landing on a task that does not host the turn preempts it through the session turn epoch instead, ending it within one lease renewal.", "response": { "$ref": "CancelAssistantTurnResponse" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.assistantSessions.cancelAssistantTurn", "parameters": { "name": { "description": "Required. The assistant session whose in-flight turn to cancel.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/assistantSessions/[^/]+$", "required": true, "type": "string", "location": "path" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/assistantSessions/{assistantSessionsId}:cancelAssistantTurn", "httpMethod": "POST", "path": "v1beta/{+name}:cancelAssistantTurn", "request": { "$ref": "CancelAssistantTurnRequest" } } } }, "changelogs": { "methods": { "get": { "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.changelogs.get", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs/{changelogsId}", "response": { "$ref": "Changelog" }, "description": "Gets the specified changelog.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/changelogs/[^/]+$", "description": "Required. The resource name of the changelog to retrieve.", "location": "path" } }, "httpMethod": "GET" }, "list": { "id": "ces.projects.locations.apps.changelogs.list", "response": { "$ref": "ListChangelogsResponse" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListChangelogs call.", "type": "string" }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" }, "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to list changelogs from." }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "description": "Optional. Filter to be applied when listing the changelogs. See https://google.aip.dev/160 for more details. The filter string can be used to filter by `action`, `resource_type`, `resource_name`, `author`, and `create_time`. The `:` comparator can be used for case-insensitive partial matching on string fields, while `=` performs an exact case-sensitive match. Examples: * `action:update` (case-insensitive partial match) * `action=\"Create\"` (case-sensitive exact match) * `resource_type:agent` * `resource_name:my-agent` * `author:me@example.com` * `create_time \u003e \"2025-01-01T00:00:00Z\"` * `create_time \u003c= \"2025-01-01T00:00:00Z\" AND resource_type:tool`", "type": "string", "location": "query" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs", "description": "Lists the changelogs of the specified app.", "path": "v1beta/{+parent}/changelogs", "parameterOrder": [ "parent" ], "httpMethod": "GET" } } }, "evaluationRuns": { "methods": { "delete": { "description": "Deletes an evaluation run.", "id": "ces.projects.locations.apps.evaluationRuns.delete", "path": "v1beta/{+name}", "response": { "$ref": "Operation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns/{evaluationRunsId}", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationRuns/[^/]+$", "location": "path", "description": "Required. The resource name of the evaluation run to delete.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE" }, "list": { "description": "Lists all evaluation runs in the given app.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns", "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "type": "string", "description": "Required. The resource name of the app to list evaluation runs from." }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter to be applied when listing the evaluation runs. See https://google.aip.dev/160 for more details." }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\", and \"update_time\" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, \"update_time\" will be the default. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" }, "pageSize": { "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" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationRuns call.", "location": "query", "type": "string" } }, "response": { "$ref": "ListEvaluationRunsResponse" }, "httpMethod": "GET", "id": "ces.projects.locations.apps.evaluationRuns.list", "path": "v1beta/{+parent}/evaluationRuns", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets details of the specified evaluation run.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns/{evaluationRunsId}", "path": "v1beta/{+name}", "id": "ces.projects.locations.apps.evaluationRuns.get", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The resource name of the evaluation run to retrieve.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluationRuns/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "EvaluationRun" }, "httpMethod": "GET" }, "export": { "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+parent}/evaluationRuns:export", "parameters": { "parent": { "description": "Required. The resource name of the app to export evaluation runs from. Format: `projects/{project}/locations/{location}/apps/{app}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true, "type": "string" } }, "id": "ces.projects.locations.apps.evaluationRuns.export", "httpMethod": "POST", "description": "Exports evaluations runs.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluationRuns:export", "request": { "$ref": "ExportEvaluationRunsRequest" } } } }, "versions": { "resources": { "message": { "methods": { "send": { "description": "Sends a message to an agent.", "id": "ces.projects.locations.apps.versions.message.send", "request": { "$ref": "LfA2aV1SendMessageRequest" }, "parameters": { "tenant": { "type": "string", "location": "path", "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "required": true } }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/message:send", "path": "v1beta/{+tenant}/message:send", "response": { "$ref": "LfA2aV1SendMessageResponse" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "tenant" ] }, "stream": { "httpMethod": "POST", "path": "v1beta/{+tenant}/message:stream", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/message:stream", "parameters": { "tenant": { "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "type": "string", "location": "path", "required": true } }, "request": { "$ref": "LfA2aV1SendMessageRequest" }, "parameterOrder": [ "tenant" ], "response": { "$ref": "LfA2aV1StreamResponse" }, "id": "ces.projects.locations.apps.versions.message.stream", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`" } } } }, "methods": { "restore": { "parameters": { "name": { "required": true, "description": "Required. The resource name of the app version to restore.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$" } }, "request": { "$ref": "RestoreAppVersionRequest" }, "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.versions.restore", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}:restore", "description": "Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version.", "path": "v1beta/{+name}:restore" }, "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}", "httpMethod": "DELETE", "id": "ces.projects.locations.apps.versions.delete", "path": "v1beta/{+name}", "description": "Deletes the specified app version.", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the app version to delete." }, "etag": { "type": "string", "location": "query", "description": "Optional. The current etag of the app version. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app version, deletion will be blocked and an ABORTED error will be returned." } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource name of the app to list app versions from.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter to be applied when listing the app versions. See https://google.aip.dev/160 for more details." }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list AgentService.ListAppVersions call.", "type": "string", "location": "query" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "format": "int32", "location": "query" }, "orderBy": { "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" } }, "id": "ces.projects.locations.apps.versions.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListAppVersionsResponse" }, "path": "v1beta/{+parent}/versions", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions", "description": "Lists all app versions in the given app." }, "getExtendedAgentCard": { "id": "ces.projects.locations.apps.versions.getExtendedAgentCard", "response": { "$ref": "LfA2aV1AgentCard" }, "parameterOrder": [ "tenant" ], "description": "Gets the extended agent card for the authenticated agent.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/extendedAgentCard", "httpMethod": "GET", "parameters": { "tenant": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "required": true, "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+tenant}/extendedAgentCard" }, "patch": { "description": "Updates the specified app version.", "response": { "$ref": "AppVersion" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "AppVersion" }, "id": "ces.projects.locations.apps.versions.patch", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "type": "string", "description": "Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "location": "path" }, "updateMask": { "location": "query", "description": "Optional. The list of fields to update. If empty, fields `display_name` and `description` will be updated.", "format": "google-fieldmask", "type": "string" } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}", "httpMethod": "PATCH" }, "get": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of the specified app version.", "path": "v1beta/{+name}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "type": "string", "description": "Required. The resource name of the app version to retrieve.", "location": "path" } }, "response": { "$ref": "AppVersion" }, "httpMethod": "GET", "id": "ces.projects.locations.apps.versions.get", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}", "parameterOrder": [ "name" ] }, "create": { "id": "ces.projects.locations.apps.versions.create", "description": "Creates a new app version in the given app.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions", "request": { "$ref": "AppVersion" }, "response": { "$ref": "AppVersion" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}/versions", "parameters": { "parent": { "description": "Required. The resource name of the app to create an app version in.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true }, "appVersionId": { "location": "query", "description": "Optional. The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.", "type": "string" } } } } } }, "methods": { "generateAppResource": { "path": "v1beta/{+parent}:generateAppResource", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:generateAppResource", "parameters": { "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app to generate the resource for.", "required": true } }, "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.generateAppResource", "response": { "$ref": "Operation" }, "httpMethod": "POST", "request": { "$ref": "GenerateAppResourceRequest" }, "description": "Generates specific resources (e.g. agent) in the app using LLM assistant.", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "retrieveToolSchema": { "request": { "$ref": "RetrieveToolSchemaRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:retrieveToolSchema", "parameterOrder": [ "parent" ], "httpMethod": "POST", "description": "Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.", "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, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+parent}:retrieveToolSchema", "response": { "$ref": "RetrieveToolSchemaResponse" } }, "testPersonaVoice": { "id": "ces.projects.locations.apps.testPersonaVoice", "description": "Tests the voice of a persona. Also accepts a default persona.", "request": { "$ref": "TestPersonaVoiceRequest" }, "path": "v1beta/{+app}:testPersonaVoice", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "TestPersonaVoiceResponse" }, "parameters": { "app": { "required": true, "description": "Required. the resource name of the app to test the persona voice for. Format: `projects/{project}/locations/{location}/apps/{app}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "type": "string", "location": "path" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:testPersonaVoice", "httpMethod": "POST", "parameterOrder": [ "app" ] }, "list": { "response": { "$ref": "ListAppsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "id": "ces.projects.locations.apps.list", "parameters": { "orderBy": { "type": "string", "location": "query", "description": "Optional. Field to sort by. Only \"name\" and \"create_time\" is supported. See https://google.aip.dev/132#ordering for more details." }, "pageToken": { "type": "string", "description": "Optional. The next_page_token value returned from a previous list AgentService.ListApps call.", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter to be applied when listing the apps. See https://google.aip.dev/160 for more details." }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "format": "int32", "location": "query" }, "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the location to list apps from.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ], "description": "Lists apps in the given project and location.", "path": "v1beta/{+parent}/apps", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps" }, "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "ces.projects.locations.apps.get", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the app to retrieve.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true } }, "path": "v1beta/{+name}", "response": { "$ref": "App" }, "description": "Gets details of the specified app." }, "generateOnboardingSuggestions": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GenerateOnboardingSuggestionsRequest" }, "httpMethod": "POST", "path": "v1beta/{+name}:generateOnboardingSuggestions", "id": "ces.projects.locations.apps.generateOnboardingSuggestions", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:generateOnboardingSuggestions", "parameters": { "name": { "required": true, "description": "Required. The app whose zero state is being rendered. Format: `projects/{project}/locations/{location}/apps/{app}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" } }, "description": "Generates personalized onboarding suggestions for the AI assistant zero state: classifies the requesting user (new / exploring / returning) from their assistant-session history in the app and returns suggestion chips (resume a session, continue work, or start something new) to render before any message is sent.", "response": { "$ref": "GenerateOnboardingSuggestionsResponse" }, "parameterOrder": [ "name" ] }, "executeTool": { "description": "Executes the given tool with the given arguments.", "response": { "$ref": "ExecuteToolResponse" }, "request": { "$ref": "ExecuteToolRequest" }, "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "description": "Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`", "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:executeTool", "path": "v1beta/{+parent}:executeTool", "httpMethod": "POST", "parameterOrder": [ "parent" ], "id": "ces.projects.locations.apps.executeTool" }, "getExtendedAgentCard": { "parameterOrder": [ "tenant" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+tenant}/extendedAgentCard", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/extendedAgentCard", "description": "Gets the extended agent card for the authenticated agent.", "parameters": { "tenant": { "required": true, "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "response": { "$ref": "LfA2aV1AgentCard" }, "id": "ces.projects.locations.apps.getExtendedAgentCard", "httpMethod": "GET" }, "importEvaluations": { "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:importEvaluations", "request": { "$ref": "ImportEvaluationsRequest" }, "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}:importEvaluations", "description": "Imports evaluations into the app.", "httpMethod": "POST", "id": "ces.projects.locations.apps.importEvaluations", "response": { "$ref": "Operation" }, "parameters": { "parent": { "required": true, "description": "Required. The app to import the evaluations into. Format: `projects/{project}/locations/{location}/apps/{app}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } } }, "exportApp": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ExportAppRequest" }, "httpMethod": "POST", "description": "Exports the specified app.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:exportApp", "parameters": { "name": { "required": true, "description": "Required. The resource name of the app to export.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" } }, "id": "ces.projects.locations.apps.exportApp", "path": "v1beta/{+name}:exportApp" }, "importApp": { "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The parent resource name with the location of the app to import." } }, "response": { "$ref": "Operation" }, "path": "v1beta/{+parent}/apps:importApp", "httpMethod": "POST", "description": "Imports the specified app.", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps:importApp", "id": "ces.projects.locations.apps.importApp", "request": { "$ref": "ImportAppRequest" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "description": "Creates a new app in the given project and location.", "request": { "$ref": "App" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "appId": { "type": "string", "location": "query", "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." }, "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the location to create an app in.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "Operation" }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps", "path": "v1beta/{+parent}/apps", "id": "ces.projects.locations.apps.create" }, "patch": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "description": "Updates the specified app.", "path": "v1beta/{+name}", "response": { "$ref": "App" }, "parameterOrder": [ "name" ], "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "updateMask": { "format": "google-fieldmask", "type": "string", "location": "query", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated." }, "name": { "required": true, "description": "Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" } }, "id": "ces.projects.locations.apps.patch", "request": { "$ref": "App" } }, "runAssistant": { "response": { "$ref": "RunAssistantResponse" }, "description": "Runs the assistant agent for the specified assistant session.", "httpMethod": "POST", "path": "v1beta/{+app}:runAssistant", "parameters": { "app": { "description": "Required. The app to run assistant for. Format: `projects/{project}/locations/{location}/apps/{app}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" } }, "parameterOrder": [ "app" ], "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:runAssistant", "id": "ces.projects.locations.apps.runAssistant", "request": { "$ref": "RunAssistantRequest" } }, "runEvaluation": { "request": { "$ref": "RunEvaluationRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:runEvaluation", "id": "ces.projects.locations.apps.runEvaluation", "description": "Runs an evaluation of the app.", "path": "v1beta/{+app}:runEvaluation", "parameters": { "app": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "description": "Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}`" } }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "app" ], "response": { "$ref": "Operation" }, "httpMethod": "POST" }, "chatAiAssistant": { "response": { "$ref": "ChatAiAssistantResponse" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+app}:chatAiAssistant", "parameters": { "app": { "required": true, "description": "Required. The app to run assistant for. Format: `projects/{project}/locations/{location}/apps/{app}`", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:chatAiAssistant", "parameterOrder": [ "app" ], "httpMethod": "POST", "description": "Runs the Chat AI assistant agent for the specified assistant session.", "request": { "$ref": "ChatAiAssistantRequest" }, "id": "ces.projects.locations.apps.chatAiAssistant" }, "delete": { "parameters": { "name": { "required": true, "description": "Required. The resource name of the app to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "location": "path", "type": "string" }, "etag": { "type": "string", "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" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}", "httpMethod": "DELETE", "description": "Deletes the specified app.", "id": "ces.projects.locations.apps.delete", "parameterOrder": [ "name" ], "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" } } } }, "operations": { "methods": { "delete": { "id": "ces.projects.locations.operations.delete", "response": { "$ref": "Empty" }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "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`.", "parameters": { "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "location": "path" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}" }, "cancel": { "id": "ces.projects.locations.operations.cancel", "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "CancelOperationRequest" }, "path": "v1beta/{+name}:cancel", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "httpMethod": "POST", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel" }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "name": { "type": "string", "description": "The name of the operation's parent resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." } }, "response": { "$ref": "ListOperationsResponse" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "ces.projects.locations.operations.list", "path": "v1beta/{+name}/operations", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "path": "v1beta/{+name}", "id": "ces.projects.locations.operations.get", "httpMethod": "GET", "response": { "$ref": "Operation" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] } } } }, "methods": { "getSecuritySettings": { "id": "ces.projects.locations.getSecuritySettings", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "response": { "$ref": "SecuritySettings" }, "parameters": { "name": { "description": "Required. The resource name of the security settings to retrieve. Format: `projects/{project}/locations/{location}/securitySettings`", "pattern": "^projects/[^/]+/locations/[^/]+/securitySettings$", "location": "path", "type": "string", "required": true } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/securitySettings", "httpMethod": "GET", "description": "Retrieves the security settings for the project and location.", "parameterOrder": [ "name" ] }, "updateSecuritySettings": { "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/securitySettings", "httpMethod": "PATCH", "parameters": { "name": { "required": true, "description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`", "pattern": "^projects/[^/]+/locations/[^/]+/securitySettings$", "type": "string", "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.", "type": "string", "location": "query", "format": "google-fieldmask" } }, "request": { "$ref": "SecuritySettings" }, "description": "Updates the security settings for the project and location.", "id": "ces.projects.locations.updateSecuritySettings", "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "SecuritySettings" } }, "list": { "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta/projects/{projectsId}/locations", "path": "v1beta/{+name}/locations", "id": "ces.projects.locations.list", "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "type": "integer", "location": "query" }, "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": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+$", "type": "string", "description": "The resource that owns the locations collection, if applicable.", "required": true, "location": "path" }, "extraLocationTypes": { "location": "query", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true, "type": "string" } }, "response": { "$ref": "ListLocationsResponse" }, "httpMethod": "GET" }, "get": { "description": "Gets information about a location.", "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "id": "ces.projects.locations.get", "parameterOrder": [ "name" ], "path": "v1beta/{+name}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Resource name for the location.", "required": true, "type": "string" } } } } } } } }, "batchPath": "batch", "documentationLink": "https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps", "endpoints": [ { "location": "us", "endpointUrl": "https://ces.us.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "eu", "endpointUrl": "https://ces.eu.rep.googleapis.com/", "description": "Regional Endpoint" } ], "basePath": "", "protocol": "rest", "version": "v1beta", "kind": "discovery#restDescription", "ownerName": "Google", "version_module": true, "parameters": { "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "$.xgafv": { "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "location": "query", "description": "V1 error format." }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "quotaUser": { "type": "string", "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "alt": { "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "default": "json", "location": "query", "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" }, "access_token": { "type": "string", "location": "query", "description": "OAuth access token." }, "key": { "type": "string", "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query", "type": "boolean" } } }