From ab5a343eae15961055c60a8aa3565210076cf86e Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 30 Jun 2026 08:17:49 +0000
Subject: [PATCH 01/41] chore: update docs/dyn/index.md
---
docs/dyn/index.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/dyn/index.md b/docs/dyn/index.md
index 461be2c6b9f..e84f5279264 100644
--- a/docs/dyn/index.md
+++ b/docs/dyn/index.md
@@ -51,6 +51,7 @@
## agentregistry
+* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/agentregistry_v1.html)
* [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/agentregistry_v1alpha.html)
From d33acf4353b2900d7edc8733640cf2341cba660a Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 30 Jun 2026 08:17:49 +0000
Subject: [PATCH 02/41] feat(aiplatform): update the api
#### aiplatform:v1
The following keys were added:
- resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine (Total Keys: 11)
- resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine (Total Keys: 15)
- resources.projects.resources.locations.resources.agents.methods.create (Total Keys: 12)
- resources.projects.resources.locations.resources.agents.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.agents.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.agents.methods.list (Total Keys: 18)
- resources.projects.resources.locations.resources.agents.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents (Total Keys: 12)
- resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list (Total Keys: 16)
- resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel (Total Keys: 11)
- resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list (Total Keys: 20)
- resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait (Total Keys: 14)
- resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision (Total Keys: 12)
- resources.semanticGovernancePolicies.resources.operations.methods.cancel (Total Keys: 11)
- resources.semanticGovernancePolicies.resources.operations.methods.delete (Total Keys: 11)
- resources.semanticGovernancePolicies.resources.operations.methods.get (Total Keys: 11)
- resources.semanticGovernancePolicies.resources.operations.methods.list (Total Keys: 20)
- resources.semanticGovernancePolicies.resources.operations.methods.wait (Total Keys: 14)
- schemas.GoogleCloudAiplatformV1Agent (Total Keys: 25)
- schemas.GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest (Total Keys: 2)
- schemas.GoogleCloudAiplatformV1GatewayConfig (Total Keys: 13)
- schemas.GoogleCloudAiplatformV1IngestEventsRequest (Total Keys: 8)
- schemas.GoogleCloudAiplatformV1IngestionDirectContentsSource (Total Keys: 10)
- schemas.GoogleCloudAiplatformV1ListAgentsResponse (Total Keys: 5)
- schemas.GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse (Total Keys: 5)
- schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy (Total Keys: 40)
- schemas.GoogleCloudAiplatformV1ToolParallelAiSearch.properties.enableDataRetention.type (Total Keys: 1)
#### aiplatform:v1beta1
The following keys were deleted:
- resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.monitoredAgents.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.monitoredAgents.methods.delete (Total Keys: 11)
- schemas.GenaiVertexV1beta1AgentInteraction.properties.code_mender_config.$ref (Total Keys: 1)
- schemas.GenaiVertexV1beta1CodeMenderAgentConfig (Total Keys: 27)
- schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.autoEnroll.type (Total Keys: 1)
- schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.targetProject.type (Total Keys: 1)
The following keys were added:
- schemas.GenaiVertexV1beta1ComputerUse.properties.enablePromptInjectionDetection.type (Total Keys: 1)
- schemas.GenaiVertexV1beta1Interaction.properties.responseModalities.deprecated (Total Keys: 1)
- schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.state (Total Keys: 2)
- schemas.GoogleCloudAiplatformV1beta1ToolParallelAiSearch.properties.enableDataRetention.type (Total Keys: 1)
---
docs/dyn/aiplatform_v1.endpoints.html | 3 +
docs/dyn/aiplatform_v1.html | 5 +
...platform_v1.projects.locations.agents.html | 373 +++++
..._v1.projects.locations.cachedContents.html | 6 +
...tform_v1.projects.locations.endpoints.html | 3 +
..._v1.projects.locations.evaluationSets.html | 7 +
.../dyn/aiplatform_v1.projects.locations.html | 125 ++
....projects.locations.publishers.models.html | 3 +
...s.locations.reasoningEngines.memories.html | 138 ++
....locations.semanticGovernancePolicies.html | 354 +++++
...semanticGovernancePolicies.operations.html | 272 ++++
...ations.semanticGovernancePolicyEngine.html | 130 ++
docs/dyn/aiplatform_v1.publishers.models.html | 3 +
...latform_v1.semanticGovernancePolicies.html | 91 ++
...semanticGovernancePolicies.operations.html | 272 ++++
docs/dyn/aiplatform_v1.v1.html | 5 +
docs/dyn/aiplatform_v1beta1.endpoints.html | 3 +
docs/dyn/aiplatform_v1beta1.interactions.html | 180 +--
...locations.agentAnomalyDetectionScopes.html | 60 +-
...ta1.projects.locations.cachedContents.html | 6 +
...m_v1beta1.projects.locations.datasets.html | 2 +
..._v1beta1.projects.locations.endpoints.html | 3 +
...a1.projects.locations.evaluationItems.html | 48 +
...ta1.projects.locations.evaluationRuns.html | 32 +
...ta1.projects.locations.evaluationSets.html | 7 +
...aiplatform_v1beta1.projects.locations.html | 18 +-
...beta1.projects.locations.interactions.html | 210 +--
...a1.projects.locations.monitoredAgents.html | 83 -
....projects.locations.publishers.models.html | 3 +
.../aiplatform_v1beta1.publishers.models.html | 3 +
docs/dyn/aiplatform_v1beta1.v1beta1.html | 7 +
.../documents/aiplatform.v1.json | 1392 +++++++++++++++--
.../documents/aiplatform.v1beta1.json | 259 +--
33 files changed, 3243 insertions(+), 863 deletions(-)
create mode 100644 docs/dyn/aiplatform_v1.projects.locations.agents.html
create mode 100644 docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicies.html
create mode 100644 docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicies.operations.html
create mode 100644 docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicyEngine.html
create mode 100644 docs/dyn/aiplatform_v1.semanticGovernancePolicies.html
create mode 100644 docs/dyn/aiplatform_v1.semanticGovernancePolicies.operations.html
diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html
index f0829dbc5cb..fd2b3c56d0a 100644
--- a/docs/dyn/aiplatform_v1.endpoints.html
+++ b/docs/dyn/aiplatform_v1.endpoints.html
@@ -668,6 +668,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -1286,6 +1287,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -2218,6 +2220,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
diff --git a/docs/dyn/aiplatform_v1.html b/docs/dyn/aiplatform_v1.html
index 61ee2cc836c..a4068f89e12 100644
--- a/docs/dyn/aiplatform_v1.html
+++ b/docs/dyn/aiplatform_v1.html
@@ -224,6 +224,11 @@ Instance Methods
Returns the schedules Resource.
+
+ semanticGovernancePolicies()
+
+Returns the semanticGovernancePolicies Resource.
+
skills()
diff --git a/docs/dyn/aiplatform_v1.projects.locations.agents.html b/docs/dyn/aiplatform_v1.projects.locations.agents.html
new file mode 100644
index 00000000000..9f1e358d386
--- /dev/null
+++ b/docs/dyn/aiplatform_v1.projects.locations.agents.html
@@ -0,0 +1,373 @@
+
+
+
+
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
+Creates an agent.
+
+ delete(name, x__xgafv=None)
+Deletes an agent.
+
+ get(name, x__xgafv=None)
+Retrieves an agent.
+
+ list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists agents in a location.
+
+ list_next()
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Updates an agent.
+Method Details
+
+
close()
+
Close httplib2 connections.
+
+
+
+
create(parent, body=None, x__xgafv=None)
+
Creates an agent.
+
+Args:
+ parent: string, Required. The resource name of the location to create the agent in. Format: `projects/{project}/locations/{location}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A Vertex agent contains instructions and configurations for the LLM to execute a certain task.
+ "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`
+ "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.
+ "created": "A String", # Output only. The time the agent was created.
+ "description": "A String", # Optional. The description of the agent.
+ "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+ "metadata": { # Optional. The metadata for the agent.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`.
+ "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.
+ "tools": [ # Optional. The tools available to the agent.
+ { # A tool provides a list of actions available to the Agent during the process of executing a task.
+ "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.
+ "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`
+ "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.
+ },
+ ],
+ "updated": "A String", # Output only. The time the agent was last updated.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # 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.
+ "error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # 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.
+ },
+ "metadata": { # 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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}`.
+ "response": { # 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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+
delete(name, x__xgafv=None)
+
Deletes an agent.
+
+Args:
+ name: string, Required. The resource name of the agent to delete. Format: `projects/{project}/locations/{location}/agents/{agent}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # 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.
+ "error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # 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.
+ },
+ "metadata": { # 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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}`.
+ "response": { # 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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+
get(name, x__xgafv=None)
+
Retrieves an agent.
+
+Args:
+ name: string, Required. The resource name of the agent to retrieve. Format: `projects/{project}/locations/{location}/agents/{agent}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A Vertex agent contains instructions and configurations for the LLM to execute a certain task.
+ "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`
+ "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.
+ "created": "A String", # Output only. The time the agent was created.
+ "description": "A String", # Optional. The description of the agent.
+ "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+ "metadata": { # Optional. The metadata for the agent.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`.
+ "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.
+ "tools": [ # Optional. The tools available to the agent.
+ { # A tool provides a list of actions available to the Agent during the process of executing a task.
+ "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.
+ "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`
+ "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.
+ },
+ ],
+ "updated": "A String", # Output only. The time the agent was last updated.
+}
+
+
+
+
list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+
Lists agents in a location.
+
+Args:
+ parent: string, Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}`. (required)
+ orderBy: string, Optional. A comma-separated list of fields to order by. Supported fields: * `created` * `updated` Use `desc` after a field name for descending order. Example: `created desc`.
+ pageSize: integer, Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10.
+ pageToken: string, Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for AgentService.ListAgents.
+ "agents": [ # The agents matching the request.
+ { # A Vertex agent contains instructions and configurations for the LLM to execute a certain task.
+ "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`
+ "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.
+ "created": "A String", # Output only. The time the agent was created.
+ "description": "A String", # Optional. The description of the agent.
+ "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+ "metadata": { # Optional. The metadata for the agent.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`.
+ "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.
+ "tools": [ # Optional. The tools available to the agent.
+ { # A tool provides a list of actions available to the Agent during the process of executing a task.
+ "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.
+ "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`
+ "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.
+ },
+ ],
+ "updated": "A String", # Output only. The time the agent was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value as ListAgentsRequest.page_token in a subsequent call.
+}
+
+
+
+
list_next()
+
Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+
patch(name, body=None, updateMask=None, x__xgafv=None)
+
Updates an agent.
+
+Args:
+ name: string, Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A Vertex agent contains instructions and configurations for the LLM to execute a certain task.
+ "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`
+ "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.
+ "created": "A String", # Output only. The time the agent was created.
+ "description": "A String", # Optional. The description of the agent.
+ "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+ "metadata": { # Optional. The metadata for the agent.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`.
+ "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.
+ "tools": [ # Optional. The tools available to the agent.
+ { # A tool provides a list of actions available to the Agent during the process of executing a task.
+ "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.
+ "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`
+ "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.
+ },
+ ],
+ "updated": "A String", # Output only. The time the agent was last updated.
+}
+
+ updateMask: string, Optional. The list of fields to update. If not present, all fields are updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A Vertex agent contains instructions and configurations for the LLM to execute a certain task.
+ "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`
+ "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.
+ "created": "A String", # Output only. The time the agent was created.
+ "description": "A String", # Optional. The description of the agent.
+ "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+ "metadata": { # Optional. The metadata for the agent.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`.
+ "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.
+ "tools": [ # Optional. The tools available to the agent.
+ { # A tool provides a list of actions available to the Agent during the process of executing a task.
+ "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.
+ "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`
+ "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.
+ },
+ ],
+ "updated": "A String", # Output only. The time the agent was last updated.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
index 559424f9a7f..7701ea32498 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
@@ -421,6 +421,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -839,6 +840,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -1282,6 +1284,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -1711,6 +1714,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -2148,6 +2152,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -2567,6 +2572,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
index 834d9ec9bb8..c0a621ff03b 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
@@ -736,6 +736,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -2250,6 +2251,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -4664,6 +4666,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html
index 797e871509e..a87310d9966 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html
@@ -259,6 +259,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -513,6 +514,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -809,6 +811,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -1096,6 +1099,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -1409,6 +1413,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -1682,6 +1687,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -1937,6 +1943,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html
index 2973a0ccd58..3323ba7d7d2 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.html
@@ -74,6 +74,11 @@
Instance Methods
+
+ agents()
+
+Returns the agents Resource.
+
batchPredictionJobs()
@@ -239,6 +244,16 @@ Instance Methods
Returns the schedules Resource.
+
+ semanticGovernancePolicies()
+
+Returns the semanticGovernancePolicies Resource.
+
+
+ semanticGovernancePolicyEngine()
+
+Returns the semanticGovernancePolicyEngine Resource.
+
skills()
@@ -311,6 +326,9 @@ Instance Methods
getRagEngineConfig(name, x__xgafv=None)
Gets a RagEngineConfig.
+
+ getSemanticGovernancePolicyEngine(name, x__xgafv=None)
+Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
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.
@@ -323,6 +341,9 @@ Instance Methods
updateRagEngineConfig(name, body=None, x__xgafv=None)
Updates a RagEngineConfig.
+
+ updateSemanticGovernancePolicyEngine(name, body=None, updateMask=None, x__xgafv=None)
+Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.
Method Details
askContexts(parent, body=None, x__xgafv=None)
@@ -489,6 +510,7 @@
Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -774,6 +796,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -2509,6 +2532,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -2826,6 +2850,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -3214,6 +3239,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -3444,6 +3470,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -5713,6 +5740,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -6636,6 +6664,7 @@ Method Details
"customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
"a_key": "", # Properties of the object.
},
+ "enableDataRetention": True or False, # Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
@@ -6819,6 +6848,42 @@ Method Details
}
+
+
getSemanticGovernancePolicyEngine(name, x__xgafv=None)
+
Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.
+
+Args:
+ name: string, Required. The resource name of the SemanticGovernancePolicyEngine to retrieve. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Define a singleton SemanticGovernancePolicyEngine resource under a project and location.
+ "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was created.
+ "gatewayConfigs": { # Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed.
+ "a_key": { # Configuration for a single gateway.
+ "dnsRecord": "A String", # Output only. The fully qualified record name of the created A-record in Cloud DNS.
+ "dnsZoneName": "A String", # Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint.
+ "ipAddress": "A String", # Output only. The private IP address of the PSC endpoint.
+ "network": "A String", # Optional. The URI of the network resource where PSC-E will be provisioned. if not provided `default` network will be used. Format: projects/{project}/global/networks/{network}
+ "pscEndpoint": "A String", # Output only. The self-link or name of the Private Service Connect endpoint forwarding rule.
+ "state": "A String", # Output only. The state of the Gateway configuration.
+ "subnetwork": "A String", # Optional. The URI of the subnetwork resource where PSC-E will be provisioned. if not provided `default` subnet will be used from the same {location} Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}
+ },
+ },
+ "ipAddress": "A String", # Output only. The private IPv4 address of the PSC endpoint.
+ "name": "A String", # Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine
+ "pscForwardingRule": "A String", # Output only. The URI of the PSC endpoint resource created in customer project. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
+ "pscServiceAttachment": "A String", # Output only. URI of the PSC attachment resource provided by SGP. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
+ "state": "A String", # Output only. The state of the SemanticGovernancePolicyEngine.
+ "updateTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was last updated.
+}
+
+
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
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.
@@ -7000,4 +7065,64 @@ Method Details
}
+
+
updateSemanticGovernancePolicyEngine(name, body=None, updateMask=None, x__xgafv=None)
+
Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.
+
+Args:
+ name: string, Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Define a singleton SemanticGovernancePolicyEngine resource under a project and location.
+ "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was created.
+ "gatewayConfigs": { # Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed.
+ "a_key": { # Configuration for a single gateway.
+ "dnsRecord": "A String", # Output only. The fully qualified record name of the created A-record in Cloud DNS.
+ "dnsZoneName": "A String", # Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint.
+ "ipAddress": "A String", # Output only. The private IP address of the PSC endpoint.
+ "network": "A String", # Optional. The URI of the network resource where PSC-E will be provisioned. if not provided `default` network will be used. Format: projects/{project}/global/networks/{network}
+ "pscEndpoint": "A String", # Output only. The self-link or name of the Private Service Connect endpoint forwarding rule.
+ "state": "A String", # Output only. The state of the Gateway configuration.
+ "subnetwork": "A String", # Optional. The URI of the subnetwork resource where PSC-E will be provisioned. if not provided `default` subnet will be used from the same {location} Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}
+ },
+ },
+ "ipAddress": "A String", # Output only. The private IPv4 address of the PSC endpoint.
+ "name": "A String", # Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine
+ "pscForwardingRule": "A String", # Output only. The URI of the PSC endpoint resource created in customer project. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
+ "pscServiceAttachment": "A String", # Output only. URI of the PSC attachment resource provided by SGP. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
+ "state": "A String", # Output only. The state of the SemanticGovernancePolicyEngine.
+ "updateTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was last updated.
+}
+
+ updateMask: string, Optional. Specifies the fields to be overwritten in the SemanticGovernancePolicyEngine resource by the update. The fields specified in the update_mask are relative to the resource itself. If no update_mask is provided, all fields are overwritten.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # 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.
+ "error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # 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.
+ },
+ "metadata": { # 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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}`.
+ "response": { # 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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+